inference-engine/include/builders/ie_region_yolo_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 RegionYolo layer
  17  */
  18 class INFERENCE_ENGINE_API_CLASS(RegionYoloLayer): public LayerDecorator {
  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 layer pointer to generic builder
  28      */
  29     explicit RegionYoloLayer(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 RegionYoloLayer(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     RegionYoloLayer& setName(const std::string& name);
  41
  42     /**
  43      * @brief Returns input port
  44      * @return Input port
  45      */
  46     const Port& getInputPort() const;
  47     /**
  48      * @brief Sets input port
  49      * @param port Input port
  50      * @return reference to layer builder
  51      */
  52     RegionYoloLayer& setInputPort(const Port& port);
  53     /**
  54      * @brief Returns output port
  55      * @return Output port
  56      */
  57     const Port& getOutputPort() const;
  58     /**
  59      * @brief Sets output port
  60      * @param port Output port
  61      * @return reference to layer builder
  62      */
  63     RegionYoloLayer& setOutputPort(const Port& port);
  64     /**
  65      * @brief Returns number of coordinates for each region
  66      * @return Number of coordinates
  67      */
  68     int getCoords() const;
  69     /**
  70      * @brief Sets number of coordinates for each region
  71      * @param coords Number of coordinates
  72      * @return reference to layer builder
  73      */
  74     RegionYoloLayer& setCoords(int coords);
  75     /**
  76      * @brief Returns number of classes for each region
  77      * @return Number of classes
  78      */
  79     int getClasses() const;
  80     /**
  81      * @brief Sets number of classes for each region
  82      * @param classes number of classes
  83      * @return reference to layer builder
  84      */
  85     RegionYoloLayer& setClasses(int classes);
  86     /**
  87      * @brief Returns number of regions
  88      * @return Number of regions
  89      */
  90     int getNum() const;
  91     /**
  92      * @brief Sets number of regions
  93      * @param num Number of regions
  94      * @return reference to layer builder
  95      */
  96     RegionYoloLayer& setNum(int num);
  97     /**
  98      * @brief Returns a flag which specifies the method of infer
  99      * @return true if softmax is performed
 100      */
 101     bool getDoSoftMax() const;
 102     /**
 103      * @brief Sets a flag which specifies the method of infer
 104      * @param flag softmax is performed if true
 105      * @return reference to layer builder
 106      */
 107     RegionYoloLayer& setDoSoftMax(bool flag);
 108     /**
 109      * @brief Returns anchors coordinates of regions
 110      * @return anchors coordinates
 111      */
 112     float getAnchors() const;
 113     /**
 114      * @brief Sets anchors coordinates of regions
 115      * @param anchors Anchors coordinates
 116      * @return reference to layer builder
 117      */
 118     RegionYoloLayer& setAnchors(float anchors);
 119     /**
 120      * @brief Returns mask
 121      * @return Mask
 122      */
 123     int getMask() const;
 124     /**
 125      * @brief Sets mask
 126      * @param mask Specifies which anchors to use
 127      * @return reference to layer builder
 128      */
 129     RegionYoloLayer& setMask(int mask);
 130     /**
 131      * @brief Returns the number of the dimension from which flattening is performed
 132      * @return Axis
 133      */
 134     size_t getAxis() const;
 135     /**
 136      * @brief Sets the number of the dimension from which flattening is performed
 137      * @param axis Axis
 138      * @return reference to layer builder
 139      */
 140     RegionYoloLayer& setAxis(size_t axis);
 141     /**
 142      * @brief Returns the number of the dimension on which flattening is ended
 143      * @return End axis
 144      */
 145     size_t getEndAxis() const;
 146     /**
 147      * @brief Sets the number of the dimension on which flattening is ended
 148      * @param axis End axis
 149      * @return reference to layer builder
 150      */
 151     RegionYoloLayer& setEndAxis(size_t axis);
 152 };
 153
 154 }  // namespace Builder
 155 }  // namespace InferenceEngine
 156
 157
 158
 159
 160