Publishing 2019 R1 content
[platform/upstream/dldt.git] / inference-engine / include / builders / 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  * @brief The class represents a builder for PSROIPooling layer
17  */
18 class INFERENCE_ENGINE_API_CLASS(PSROIPoolingLayer): public LayerDecorator {
19 public:
20     /**
21      * @brief The constructor creates a builder with the name
22      * @param name Layer name
23      */
24     explicit PSROIPoolingLayer(const std::string& name = "");
25     /**
26      * @brief The constructor creates a builder from generic builder
27      * @param layer pointer to generic builder
28      */
29     explicit PSROIPoolingLayer(const Layer::Ptr& layer);
30     /**
31      * @brief The constructor creates a builder from generic builder
32      * @param layer constant pointer to generic builder
33      */
34     explicit PSROIPoolingLayer(const Layer::CPtr& layer);
35     /**
36      * @brief Sets the name for the layer
37      * @param name Layer name
38      * @return reference to layer builder
39      */
40     PSROIPoolingLayer& setName(const std::string& name);
41
42     /**
43      * @brief Returns input ports
44      * @return Vector of input ports
45      */
46     const std::vector<Port>& getInputPorts() const;
47     /**
48      * @brief Sets input ports
49      * @param ports Vector of input ports
50      * @return reference to layer builder
51      */
52     PSROIPoolingLayer& setInputPorts(const std::vector<Port>& ports);
53     /**
54      * @brief Returns output ports
55      * @return Vector of output ports
56      */
57     const Port& getOutputPort() const;
58     /**
59      * @brief Sets output ports
60      * @param port Vector of output ports
61      * @return reference to layer builder
62      */
63     PSROIPoolingLayer& setOutputPort(const Port& port);
64     /**
65      * @brief Returns multiplicative spatial scale factor to translate ROI coordinates
66      * @return Spatial scale factor
67      */
68     float getSpatialScale() const;
69     /**
70      * @brief Sets multiplicative spatial scale factor to translate ROI coordinates
71      * @param spatialScale Spatial scale factor
72      * @return reference to layer builder
73      */
74     PSROIPoolingLayer& setSpatialScale(float spatialScale);
75     /**
76      * @brief Returns pooled output channel number
77      * @return Output channel number
78      */
79     size_t getOutputDim() const;
80     /**
81      * @brief Sets pooled output channel number
82      * @param outDim Output channel number
83      * @return reference to layer builder
84      */
85     PSROIPoolingLayer& setOutputDim(size_t outDim);
86     /**
87      * @brief Returns number of groups to encode position-sensitive score maps
88      * @return Number of groups
89      */
90     size_t getGroupSize() const;
91     /**
92      * @brief Sets number of groups to encode position-sensitive score maps
93      * @param size Number of groups
94      * @return reference to layer builder
95      */
96     PSROIPoolingLayer& setGroupSize(size_t size);
97 };
98
99 }  // namespace Builder
100 }  // namespace InferenceEngine
101
102
103