ie_region_yolo_layer.hpp
1 // Copyright (C) 2018 Intel Corporation
2 // SPDX-License-Identifier: Apache-2.0
3 //
4 
5 #pragma once
6 
7 #include <builders/ie_layer_fragment.hpp>
8 #include <ie_inetwork.hpp>
9 #include <string>
10 #include <vector>
11 
12 namespace InferenceEngine {
13 namespace Builder {
14 
15 /**
16  * @brief The class represents a builder for RegionYolo layer
17  */
18 class INFERENCE_ENGINE_API_CLASS(RegionYoloLayer): public LayerFragment {
19 public:
20  /**
21  * @brief The constructor creates a builder with the name
22  * @param name Layer name
23  */
24  explicit RegionYoloLayer(const std::string& name = "");
25  /**
26  * @brief The constructor creates a builder from generic builder
27  * @param genLayer generic builder
28  */
29  explicit RegionYoloLayer(Layer& genLayer);
30  /**
31  * @brief Sets the name for the layer
32  * @param name Layer name
33  * @return reference to layer builder
34  */
35  RegionYoloLayer& setName(const std::string& name);
36 
37  /**
38  * @brief Returns input port
39  * @return Input port
40  */
41  const Port& getInputPort() const;
42  /**
43  * @brief Sets input port
44  * @param port Input port
45  * @return reference to layer builder
46  */
47  RegionYoloLayer& setInputPort(const Port& port);
48  /**
49  * @brief Returns output port
50  * @return Output port
51  */
52  const Port& getOutputPort() const;
53  /**
54  * @brief Sets output port
55  * @param port Output port
56  * @return reference to layer builder
57  */
58  RegionYoloLayer& setOutputPort(const Port& port);
59  /**
60  * @brief Returns number of coordinates for each region
61  * @return Number of coordinates
62  */
63  int getCoords() const;
64  /**
65  * @brief Sets number of coordinates for each region
66  * @param coords Number of coordinates
67  * @return reference to layer builder
68  */
69  RegionYoloLayer& setCoords(int coords);
70  /**
71  * @brief Returns number of classes for each region
72  * @return Number of classes
73  */
74  int getClasses() const;
75  /**
76  * @brief Sets number of classes for each region
77  * @param classes number of classes
78  * @return reference to layer builder
79  */
80  RegionYoloLayer& setClasses(int classes);
81  /**
82  * @brief Returns number of regions
83  * @return Number of regions
84  */
85  int getNum() const;
86  /**
87  * @brief Sets number of regions
88  * @param num Number of regions
89  * @return reference to layer builder
90  */
91  RegionYoloLayer& setNum(int num);
92  /**
93  * @brief Returns a flag which specifies the method of infer
94  * @return true if softmax is performed
95  */
96  bool getDoSoftMax() const;
97  /**
98  * @brief Sets a flag which specifies the method of infer
99  * @param flag softmax is performed if true
100  * @return reference to layer builder
101  */
102  RegionYoloLayer& setDoSoftMax(bool flag);
103  /**
104  * @brief Returns anchors coordinates of regions
105  * @return anchors coordinates
106  */
107  float getAnchors() const;
108  /**
109  * @brief Sets anchors coordinates of regions
110  * @param anchors Anchors coordinates
111  * @return reference to layer builder
112  */
113  RegionYoloLayer& setAnchors(float anchors);
114  /**
115  * @brief Returns mask
116  * @return Mask
117  */
118  int getMask() const;
119  /**
120  * @brief Sets mask
121  * @param mask Specifies which anchors to use
122  * @return reference to layer builder
123  */
124  RegionYoloLayer& setMask(int mask);
125  /**
126  * @brief Returns the number of the dimension from which flattening is performed
127  * @return Axis
128  */
129  size_t getAxis() const;
130  /**
131  * @brief Sets the number of the dimension from which flattening is performed
132  * @param axis Axis
133  * @return reference to layer builder
134  */
135  RegionYoloLayer& setAxis(size_t axis);
136  /**
137  * @brief Returns the number of the dimension on which flattening is ended
138  * @return End axis
139  */
140  size_t getEndAxis() const;
141  /**
142  * @brief Sets the number of the dimension on which flattening is ended
143  * @param axis End axis
144  * @return reference to layer builder
145  */
146  RegionYoloLayer& setEndAxis(size_t axis);
147 };
148 
149 } // namespace Builder
150 } // namespace InferenceEngine
151 
152 
153 
154 
155 
InferenceEngine
Definition: ie_argmax_layer.hpp:11
ie_inetwork.hpp
a header file for the Inference Engine Network interface