Public Member Functions
InferenceEngine::Builder::DetectionOutputLayer Class Reference

The class represents a builder for Detection Output layer. More...

#include <ie_detection_output_layer.hpp>

Inheritance diagram for InferenceEngine::Builder::DetectionOutputLayer:
Inheritance graph
[legend]
Collaboration diagram for InferenceEngine::Builder::DetectionOutputLayer:
Collaboration graph
[legend]

Public Member Functions

 DetectionOutputLayer (const std::string &name="")
 The constructor creates a builder with the name. More...
 
 DetectionOutputLayer (const Layer::Ptr &layer)
 The constructor creates a builder from generic builder. More...
 
 DetectionOutputLayer (const Layer::CPtr &layer)
 The constructor creates a builder from generic builder. More...
 
DetectionOutputLayersetName (const std::string &name)
 Sets the name for the layer. More...
 
const PortgetOutputPort () const
 Returns output port. More...
 
DetectionOutputLayersetOutputPort (const Port &port)
 Sets output port. More...
 
const std::vector< Port > & getInputPorts () const
 Returns input ports. More...
 
DetectionOutputLayersetInputPorts (const std::vector< Port > &ports)
 Sets input ports. More...
 
size_t getNumClasses () const
 Returns number of classes. More...
 
DetectionOutputLayersetNumClasses (size_t num)
 Sets number of classes to be predict. More...
 
int getBackgroudLabelId () const
 Returns background label ID. More...
 
DetectionOutputLayersetBackgroudLabelId (int labelId)
 Sets background label ID. More...
 
int getTopK () const
 Returns maximum number of results to be kept on NMS stage. More...
 
DetectionOutputLayersetTopK (int topK)
 Sets maximum number of results to be kept on NMS stage. More...
 
int getKeepTopK () const
 Returns number of total boxes to be kept per image after NMS step. More...
 
DetectionOutputLayersetKeepTopK (int topK)
 Sets number of total boxes to be kept per image after NMS step. More...
 
int getNumOrientClasses () const
 Returns number of oriented classes. More...
 
DetectionOutputLayersetNumOrientClasses (int numClasses)
 Sets number of oriented classes. More...
 
std::string getCodeType () const
 Returns type of coding method for bounding boxes. More...
 
DetectionOutputLayersetCodeType (std::string type)
 Sets type of coding method for bounding boxes. More...
 
int getInterpolateOrientation () const
 Returns interpolate orientation. More...
 
DetectionOutputLayersetInterpolateOrientation (int orient)
 Sets interpolate orientation. More...
 
float getNMSThreshold () const
 Returns threshold to be used in NMS stage. More...
 
DetectionOutputLayersetNMSThreshold (float threshold)
 Sets threshold to be used in NMS stage. More...
 
float getConfidenceThreshold () const
 Returns confidence threshold. More...
 
DetectionOutputLayersetConfidenceThreshold (float threshold)
 Sets confidence threshold. More...
 
bool getShareLocation () const
 Returns share location. More...
 
DetectionOutputLayersetShareLocation (bool flag)
 Sets share location. More...
 
bool getVariantEncodedInTarget () const
 Returns encoded settings. More...
 
DetectionOutputLayersetVariantEncodedInTarget (bool flag)
 Sets encoded settings. More...
 
- Public Member Functions inherited from InferenceEngine::Builder::LayerDecorator
 LayerDecorator (const std::string &type, const std::string &name)
 The constructor creates layer builders with layer type and layer name. More...
 
 LayerDecorator (const Layer::Ptr &layer)
 The constructor creates layer builders from reference to generic layer builder. More...
 
 LayerDecorator (const Layer::CPtr &layer)
 The constructor creates layer builders from reference to generic layer builder. More...
 
 LayerDecorator (const LayerDecorator &rval)
 The copy constructor. More...
 
LayerDecoratoroperator= (const LayerDecorator &rval)
 Copy operator for LayerDecorator. More...
 
virtual ~LayerDecorator ()=default
 Virtual destructor.
 
virtual operator Layer () const
 The operator creates generic builder. More...
 
virtual operator Layer::Ptr ()
 The operator creates generic builder. More...
 
virtual operator Layer::CPtr () const
 The operator creates generic builder. More...
 
const std::string & getType () const
 Returns layer type. More...
 
const std::string & getName () const
 Returns layer name. More...
 

Additional Inherited Members

- Protected Member Functions inherited from InferenceEngine::Builder::LayerDecorator
Layer::PtrgetLayer ()
 
const Layer::CPtr getLayer () const
 
void checkType (const std::string &type) const
 
- Protected Attributes inherited from InferenceEngine::Builder::LayerDecorator
Layer::CPtr cLayer
 

Detailed Description

The class represents a builder for Detection Output layer.

Deprecated:
Use ngraph API instead.

Constructor & Destructor Documentation

§ DetectionOutputLayer() [1/3]

InferenceEngine::Builder::DetectionOutputLayer::DetectionOutputLayer ( const std::string &  name = "")
explicit

The constructor creates a builder with the name.

Parameters
nameLayer name

§ DetectionOutputLayer() [2/3]

InferenceEngine::Builder::DetectionOutputLayer::DetectionOutputLayer ( const Layer::Ptr layer)
explicit

The constructor creates a builder from generic builder.

Parameters
layerpointer to generic builder

§ DetectionOutputLayer() [3/3]

InferenceEngine::Builder::DetectionOutputLayer::DetectionOutputLayer ( const Layer::CPtr layer)
explicit

The constructor creates a builder from generic builder.

Parameters
layerconstant pointer to generic builder

Member Function Documentation

§ getBackgroudLabelId()

int InferenceEngine::Builder::DetectionOutputLayer::getBackgroudLabelId ( ) const

Returns background label ID.

Returns
Background ID

§ getCodeType()

std::string InferenceEngine::Builder::DetectionOutputLayer::getCodeType ( ) const

Returns type of coding method for bounding boxes.

Returns
String with code type

§ getConfidenceThreshold()

float InferenceEngine::Builder::DetectionOutputLayer::getConfidenceThreshold ( ) const

Returns confidence threshold.

Returns
Threshold

§ getInputPorts()

const std::vector<Port>& InferenceEngine::Builder::DetectionOutputLayer::getInputPorts ( ) const

Returns input ports.

Returns
Vector of input ports

§ getInterpolateOrientation()

int InferenceEngine::Builder::DetectionOutputLayer::getInterpolateOrientation ( ) const

Returns interpolate orientation.

Returns
Interpolate orientation

§ getKeepTopK()

int InferenceEngine::Builder::DetectionOutputLayer::getKeepTopK ( ) const

Returns number of total boxes to be kept per image after NMS step.

Returns
Keep top K

§ getNMSThreshold()

float InferenceEngine::Builder::DetectionOutputLayer::getNMSThreshold ( ) const

Returns threshold to be used in NMS stage.

Returns
Threshold

§ getNumClasses()

size_t InferenceEngine::Builder::DetectionOutputLayer::getNumClasses ( ) const

Returns number of classes.

Returns
Number of classes

§ getNumOrientClasses()

int InferenceEngine::Builder::DetectionOutputLayer::getNumOrientClasses ( ) const

Returns number of oriented classes.

Returns
Number of oriented classes

§ getOutputPort()

const Port& InferenceEngine::Builder::DetectionOutputLayer::getOutputPort ( ) const

Returns output port.

Returns
Output port

§ getShareLocation()

bool InferenceEngine::Builder::DetectionOutputLayer::getShareLocation ( ) const

Returns share location.

Returns
true if bounding boxes are shared among different classes

§ getTopK()

int InferenceEngine::Builder::DetectionOutputLayer::getTopK ( ) const

Returns maximum number of results to be kept on NMS stage.

Returns
Top K

§ getVariantEncodedInTarget()

bool InferenceEngine::Builder::DetectionOutputLayer::getVariantEncodedInTarget ( ) const

Returns encoded settings.

Returns
true if variance is encoded in target

§ setBackgroudLabelId()

DetectionOutputLayer& InferenceEngine::Builder::DetectionOutputLayer::setBackgroudLabelId ( int  labelId)

Sets background label ID.

Parameters
labelIdBackground ID if there is no background class, set it to -1.
Returns
reference to layer builder

§ setCodeType()

DetectionOutputLayer& InferenceEngine::Builder::DetectionOutputLayer::setCodeType ( std::string  type)

Sets type of coding method for bounding boxes.

Parameters
typeType
Returns
reference to layer builder

§ setConfidenceThreshold()

DetectionOutputLayer& InferenceEngine::Builder::DetectionOutputLayer::setConfidenceThreshold ( float  threshold)

Sets confidence threshold.

Parameters
thresholdThreshold
Returns
reference to layer builder

§ setInputPorts()

DetectionOutputLayer& InferenceEngine::Builder::DetectionOutputLayer::setInputPorts ( const std::vector< Port > &  ports)

Sets input ports.

Parameters
portsVector of input ports
Returns
reference to layer builder

§ setInterpolateOrientation()

DetectionOutputLayer& InferenceEngine::Builder::DetectionOutputLayer::setInterpolateOrientation ( int  orient)

Sets interpolate orientation.

Parameters
orientOrientation
Returns
reference to layer builder

§ setKeepTopK()

DetectionOutputLayer& InferenceEngine::Builder::DetectionOutputLayer::setKeepTopK ( int  topK)

Sets number of total boxes to be kept per image after NMS step.

Parameters
topKKeep top K
Returns
reference to layer builder

§ setName()

DetectionOutputLayer& InferenceEngine::Builder::DetectionOutputLayer::setName ( const std::string &  name)

Sets the name for the layer.

Parameters
nameLayer name
Returns
reference to layer builder

§ setNMSThreshold()

DetectionOutputLayer& InferenceEngine::Builder::DetectionOutputLayer::setNMSThreshold ( float  threshold)

Sets threshold to be used in NMS stage.

Parameters
thresholdNMS threshold
Returns
reference to layer builder

§ setNumClasses()

DetectionOutputLayer& InferenceEngine::Builder::DetectionOutputLayer::setNumClasses ( size_t  num)

Sets number of classes to be predict.

Parameters
numNumber of classes
Returns
reference to layer builder

§ setNumOrientClasses()

DetectionOutputLayer& InferenceEngine::Builder::DetectionOutputLayer::setNumOrientClasses ( int  numClasses)

Sets number of oriented classes.

Parameters
numClassesNumber of classes
Returns
reference to layer builder

§ setOutputPort()

DetectionOutputLayer& InferenceEngine::Builder::DetectionOutputLayer::setOutputPort ( const Port port)

Sets output port.

Parameters
portOutput port
Returns
reference to layer builder

§ setShareLocation()

DetectionOutputLayer& InferenceEngine::Builder::DetectionOutputLayer::setShareLocation ( bool  flag)

Sets share location.

Parameters
flagtrue if bounding boxes are shared among different classes
Returns
reference to layer builder

§ setTopK()

DetectionOutputLayer& InferenceEngine::Builder::DetectionOutputLayer::setTopK ( int  topK)

Sets maximum number of results to be kept on NMS stage.

Parameters
topKTop K
Returns
reference to layer builder

§ setVariantEncodedInTarget()

DetectionOutputLayer& InferenceEngine::Builder::DetectionOutputLayer::setVariantEncodedInTarget ( bool  flag)

Sets encoded settings.

Parameters
flagtrue if variance is encoded in target
Returns
reference to layer builder

The documentation for this class was generated from the following file: