ie_psroi_pooling_layer.hpp
1 // Copyright (C) 2018-2019 Intel Corporation
2 // SPDX-License-Identifier: Apache-2.0
3 //
4 
5 #pragma once
6 
7 #include <builders/ie_layer_decorator.hpp>
8 #include <ie_network.hpp>
9 #include <string>
10 #include <vector>
11 
12 namespace InferenceEngine {
13 namespace Builder {
14 
15 /**
16  * @deprecated Use ngraph API instead.
17  * @brief The class represents a builder for PSROIPooling layer
18  */
19 IE_SUPPRESS_DEPRECATED_START
20 class INFERENCE_ENGINE_NN_BUILDER_API_CLASS(PSROIPoolingLayer): public LayerDecorator {
21 public:
22  /**
23  * @brief The constructor creates a builder with the name
24  * @param name Layer name
25  */
26  explicit PSROIPoolingLayer(const std::string& name = "");
27  /**
28  * @brief The constructor creates a builder from generic builder
29  * @param layer pointer to generic builder
30  */
31  explicit PSROIPoolingLayer(const Layer::Ptr& layer);
32  /**
33  * @brief The constructor creates a builder from generic builder
34  * @param layer constant pointer to generic builder
35  */
36  explicit PSROIPoolingLayer(const Layer::CPtr& layer);
37  /**
38  * @brief Sets the name for the layer
39  * @param name Layer name
40  * @return reference to layer builder
41  */
42  PSROIPoolingLayer& setName(const std::string& name);
43 
44  /**
45  * @brief Returns input ports
46  * @return Vector of input ports
47  */
48  const std::vector<Port>& getInputPorts() const;
49  /**
50  * @brief Sets input ports
51  * @param ports Vector of input ports
52  * @return reference to layer builder
53  */
54  PSROIPoolingLayer& setInputPorts(const std::vector<Port>& ports);
55  /**
56  * @brief Returns output ports
57  * @return Vector of output ports
58  */
59  const Port& getOutputPort() const;
60  /**
61  * @brief Sets output ports
62  * @param port Vector of output ports
63  * @return reference to layer builder
64  */
65  PSROIPoolingLayer& setOutputPort(const Port& port);
66  /**
67  * @brief Returns multiplicative spatial scale factor to translate ROI coordinates
68  * @return Spatial scale factor
69  */
70  float getSpatialScale() const;
71  /**
72  * @brief Sets multiplicative spatial scale factor to translate ROI coordinates
73  * @param spatialScale Spatial scale factor
74  * @return reference to layer builder
75  */
76  PSROIPoolingLayer& setSpatialScale(float spatialScale);
77  /**
78  * @brief Returns pooled output channel number
79  * @return Output channel number
80  */
81  size_t getOutputDim() const;
82  /**
83  * @brief Sets pooled output channel number
84  * @param outDim Output channel number
85  * @return reference to layer builder
86  */
87  PSROIPoolingLayer& setOutputDim(size_t outDim);
88  /**
89  * @brief Returns number of groups to encode position-sensitive score maps
90  * @return Number of groups
91  */
92  size_t getGroupSize() const;
93  /**
94  * @brief Sets number of groups to encode position-sensitive score maps
95  * @param size Number of groups
96  * @return reference to layer builder
97  */
98  PSROIPoolingLayer& setGroupSize(size_t size);
99 };
100 IE_SUPPRESS_DEPRECATED_END
101 
102 } // namespace Builder
103 } // namespace InferenceEngine
Inference Engine API.
Definition: ie_argmax_layer.hpp:11