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

The class represents a builder for PriorBox layer. More...

#include <ie_prior_box_layer.hpp>

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

Public Member Functions

 PriorBoxLayer (const std::string &name="")
 The constructor creates a builder with the name. More...
 
 PriorBoxLayer (const Layer::Ptr &layer)
 The constructor creates a builder from generic builder. More...
 
 PriorBoxLayer (const Layer::CPtr &layer)
 The constructor creates a builder from generic builder. More...
 
PriorBoxLayersetName (const std::string &name)
 Sets the name for the layer. More...
 
const PortgetOutputPort () const
 Returns output port. More...
 
PriorBoxLayersetOutputPort (const Port &port)
 Sets output port. More...
 
const std::vector< Port > & getInputPorts () const
 Returns input ports. More...
 
PriorBoxLayersetInputPorts (const std::vector< Port > &ports)
 Sets input ports. More...
 
size_t getMinSize () const
 Returns the minimum box size in pixels. More...
 
PriorBoxLayersetMinSize (size_t minSize)
 Sets the minimum box size in pixels. More...
 
size_t getMaxSize () const
 Returns the maximum box size in pixels. More...
 
PriorBoxLayersetMaxSize (size_t maxSize)
 Sets the maximum box size in pixels. More...
 
float getStep () const
 Returns a distance between box centers. More...
 
PriorBoxLayersetStep (float step)
 Sets a distance between box centers. More...
 
float getOffset () const
 Returns a shift of box respectively to top left corner. More...
 
PriorBoxLayersetOffset (float offset)
 Sets a shift of box respectively to top left corner. More...
 
float getVariance () const
 Returns a variance of adjusting bounding boxes. More...
 
PriorBoxLayersetVariance (float variance)
 Sets a variance of adjusting bounding boxes. More...
 
bool getScaleAllSizes () const
 Returns a flag that denotes type of inference. More...
 
PriorBoxLayersetScaleAllSizes (bool flag)
 Sets a flag that denotes a type of inference. More...
 
bool getClip () const
 Returns clip flag. More...
 
PriorBoxLayersetClip (bool flag)
 sets clip flag More...
 
bool getFlip () const
 Returns flip flag. More...
 
PriorBoxLayersetFlip (bool flag)
 Sets flip flag. More...
 
const std::vector< size_t > getAspectRatio () const
 Returns a variance of aspect ratios. More...
 
PriorBoxLayersetAspectRatio (const std::vector< size_t > &aspectRatio)
 Sets a variance of aspect ratios. 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 PriorBox layer.

Deprecated:
Use ngraph API instead.

Constructor & Destructor Documentation

§ PriorBoxLayer() [1/3]

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

The constructor creates a builder with the name.

Parameters
nameLayer name

§ PriorBoxLayer() [2/3]

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

The constructor creates a builder from generic builder.

Parameters
layerpointer to generic builder

§ PriorBoxLayer() [3/3]

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

The constructor creates a builder from generic builder.

Parameters
layerconstant pointer to generic builder

Member Function Documentation

§ getAspectRatio()

const std::vector<size_t> InferenceEngine::Builder::PriorBoxLayer::getAspectRatio ( ) const

Returns a variance of aspect ratios.

Returns
Vector of aspect ratios

§ getClip()

bool InferenceEngine::Builder::PriorBoxLayer::getClip ( ) const

Returns clip flag.

Returns
true if each value in the output blob is within [0,1]

§ getFlip()

bool InferenceEngine::Builder::PriorBoxLayer::getFlip ( ) const

Returns flip flag.

Returns
list of boxes is augmented with the flipped ones if true

§ getInputPorts()

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

Returns input ports.

Returns
Vector of input ports

§ getMaxSize()

size_t InferenceEngine::Builder::PriorBoxLayer::getMaxSize ( ) const

Returns the maximum box size in pixels.

Returns
maximum size

§ getMinSize()

size_t InferenceEngine::Builder::PriorBoxLayer::getMinSize ( ) const

Returns the minimum box size in pixels.

Returns
Minimum box size

§ getOffset()

float InferenceEngine::Builder::PriorBoxLayer::getOffset ( ) const

Returns a shift of box respectively to top left corner.

Returns
Shift

§ getOutputPort()

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

Returns output port.

Returns
Output port

§ getScaleAllSizes()

bool InferenceEngine::Builder::PriorBoxLayer::getScaleAllSizes ( ) const

Returns a flag that denotes type of inference.

Returns
true if max_size is used

§ getStep()

float InferenceEngine::Builder::PriorBoxLayer::getStep ( ) const

Returns a distance between box centers.

Returns
Distance

§ getVariance()

float InferenceEngine::Builder::PriorBoxLayer::getVariance ( ) const

Returns a variance of adjusting bounding boxes.

Returns
Variance

§ setAspectRatio()

PriorBoxLayer& InferenceEngine::Builder::PriorBoxLayer::setAspectRatio ( const std::vector< size_t > &  aspectRatio)

Sets a variance of aspect ratios.

Parameters
aspectRatioVector of aspect ratios
Returns
reference to layer builder

§ setClip()

PriorBoxLayer& InferenceEngine::Builder::PriorBoxLayer::setClip ( bool  flag)

sets clip flag

Parameters
flagtrue if each value in the output blob is within [0,1]
Returns
reference to layer builder

§ setFlip()

PriorBoxLayer& InferenceEngine::Builder::PriorBoxLayer::setFlip ( bool  flag)

Sets flip flag.

Parameters
flagtrue if list of boxes is augmented with the flipped ones
Returns
reference to layer builder

§ setInputPorts()

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

Sets input ports.

Parameters
portsVector of input ports
Returns
reference to layer builder

§ setMaxSize()

PriorBoxLayer& InferenceEngine::Builder::PriorBoxLayer::setMaxSize ( size_t  maxSize)

Sets the maximum box size in pixels.

Parameters
maxSizeMaximum size
Returns
reference to layer builder

§ setMinSize()

PriorBoxLayer& InferenceEngine::Builder::PriorBoxLayer::setMinSize ( size_t  minSize)

Sets the minimum box size in pixels.

Parameters
minSizeMinimum size
Returns
reference to layer builder

§ setName()

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

Sets the name for the layer.

Parameters
nameLayer name
Returns
reference to layer builder

§ setOffset()

PriorBoxLayer& InferenceEngine::Builder::PriorBoxLayer::setOffset ( float  offset)

Sets a shift of box respectively to top left corner.

Parameters
offsetShift
Returns
reference to layer builder

§ setOutputPort()

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

Sets output port.

Parameters
portOutput port
Returns
reference to layer builder

§ setScaleAllSizes()

PriorBoxLayer& InferenceEngine::Builder::PriorBoxLayer::setScaleAllSizes ( bool  flag)

Sets a flag that denotes a type of inference.

Parameters
flagmax_size is used if true
Returns
reference to layer builder

§ setStep()

PriorBoxLayer& InferenceEngine::Builder::PriorBoxLayer::setStep ( float  step)

Sets a distance between box centers.

Parameters
stepDistance
Returns
reference to layer builder

§ setVariance()

PriorBoxLayer& InferenceEngine::Builder::PriorBoxLayer::setVariance ( float  variance)

Sets a variance of adjusting bounding boxes.

Parameters
varianceVariance
Returns
reference to layer builder

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