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

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

#include <ie_prior_box_clustered_layer.hpp>

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

Public Member Functions

  PriorBoxClusteredLayer (const std::string &name="")
  The constructor creates a builder with the name. More...
 
  PriorBoxClusteredLayer (const Layer::Ptr &layer)
  The constructor creates a builder from generic builder. More...
 
  PriorBoxClusteredLayer (const Layer::CPtr &layer)
  The constructor creates a builder from generic builder. More...
 
PriorBoxClusteredLayer setName (const std::string &name)
  Sets the name for the layer. More...
 
const Port getOutputPort () const
  Returns output port. More...
 
PriorBoxClusteredLayer setOutputPort (const Port &port)
  Sets output port. More...
 
const std::vector< Port > &  getInputPorts () const
  Returns input ports. More...
 
PriorBoxClusteredLayer setInputPorts (const std::vector< Port > &port)
  Sets input ports. More...
 
const std::vector< float >  getImgSizes () const
  Returns height and width of input image. More...
 
PriorBoxClusteredLayer setImgSizes (const std::vector< float > sizes)
  Sets height and width sizes. More...
 
const std::vector< float >  getSteps () const
  returns distances between (height and width) box centers More...
 
PriorBoxClusteredLayer setSteps (const std::vector< float > steps)
  Sets distances between box centers for height and width. More...
 
float  getStep () const
  returns a distance between box centers More...
 
PriorBoxClusteredLayer setStep (float step)
  Sets a distance between box centers. More...
 
float  getOffset () const
  Returns shift of box respectively to top left corner. More...
 
PriorBoxClusteredLayer setOffset (float offset)
  Sets shift of box respectively to top left corner. More...
 
float  getVariance () const
  Returns a variance of adjusting bounding boxes. More...
 
PriorBoxClusteredLayer setVariance (float variance)
  Sets a variance of adjusting bounding boxes. More...
 
float  getWidth () const
  Returns desired boxes width in pixels. More...
 
PriorBoxClusteredLayer setWidth (float width)
  Sets desired boxes width in pixels. More...
 
float  getHeight () const
  Returns desired boxes height in pixels. More...
 
PriorBoxClusteredLayer setHeight (float height)
  Sets desired boxes height in pixels. More...
 
bool  getClip () const
  Returns clip flag. More...
 
PriorBoxClusteredLayer setClip (bool flag)
  sets clip flag More...
 
bool  getFlip () const
  Returns flip flag. More...
 
PriorBoxClusteredLayer setFlip (bool flag)
  Sets flip flag. 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...
 
LayerDecorator operator= (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::Ptr getLayer ()
 
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 PriorBoxClustered layer.

Constructor & Destructor Documentation

§ PriorBoxClusteredLayer() [1/3]

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

The constructor creates a builder with the name.

Parameters
name Layer name

§ PriorBoxClusteredLayer() [2/3]

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

The constructor creates a builder from generic builder.

Parameters
layer pointer to generic builder

§ PriorBoxClusteredLayer() [3/3]

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

The constructor creates a builder from generic builder.

Parameters
layer constant pointer to generic builder

Member Function Documentation

§ getClip()

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

Returns clip flag.

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

§ getFlip()

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

Returns flip flag.

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

§ getHeight()

float InferenceEngine::Builder::PriorBoxClusteredLayer::getHeight ( ) const

Returns desired boxes height in pixels.

Returns
height of desired boxes

§ getImgSizes()

const std::vector<float> InferenceEngine::Builder::PriorBoxClusteredLayer::getImgSizes ( ) const

Returns height and width of input image.

Returns
input image sizes

§ getInputPorts()

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

Returns input ports.

Returns
Vector of input ports

§ getOffset()

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

Returns shift of box respectively to top left corner.

Returns
Shift

§ getOutputPort()

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

Returns output port.

Returns
Output port

§ getStep()

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

returns a distance between box centers

Returns
distance

§ getSteps()

const std::vector<float> InferenceEngine::Builder::PriorBoxClusteredLayer::getSteps ( ) const

returns distances between (height and width) box centers

Returns
distances

§ getVariance()

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

Returns a variance of adjusting bounding boxes.

Returns
Variance

§ getWidth()

float InferenceEngine::Builder::PriorBoxClusteredLayer::getWidth ( ) const

Returns desired boxes width in pixels.

Returns
width of desired boxes

§ setClip()

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

sets clip flag

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

§ setFlip()

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

Sets flip flag.

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

§ setHeight()

PriorBoxClusteredLayer& InferenceEngine::Builder::PriorBoxClusteredLayer::setHeight ( float  height )

Sets desired boxes height in pixels.

Parameters
height Height of desired boxes
Returns
reference to layer builder

§ setImgSizes()

PriorBoxClusteredLayer& InferenceEngine::Builder::PriorBoxClusteredLayer::setImgSizes ( const std::vector< float >  sizes )

Sets height and width sizes.

Parameters
sizes Height and width sizes
Returns
reference to layer builder

§ setInputPorts()

PriorBoxClusteredLayer& InferenceEngine::Builder::PriorBoxClusteredLayer::setInputPorts ( const std::vector< Port > &  port )

Sets input ports.

Parameters
port Vector of input ports
Returns
reference to layer builder

§ setName()

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

Sets the name for the layer.

Parameters
name Layer name
Returns
reference to layer builder

§ setOffset()

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

Sets shift of box respectively to top left corner.

Parameters
offset Shift
Returns
reference to layer builder

§ setOutputPort()

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

Sets output port.

Parameters
port Output port
Returns
reference to layer builder

§ setStep()

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

Sets a distance between box centers.

Parameters
steps A distance between box centers
Returns
reference to layer builder

§ setSteps()

PriorBoxClusteredLayer& InferenceEngine::Builder::PriorBoxClusteredLayer::setSteps ( const std::vector< float >  steps )

Sets distances between box centers for height and width.

Parameters
steps Distances between box centers
Returns
reference to layer builder

§ setVariance()

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

Sets a variance of adjusting bounding boxes.

Parameters
variance Variance
Returns
reference to layer builder

§ setWidth()

PriorBoxClusteredLayer& InferenceEngine::Builder::PriorBoxClusteredLayer::setWidth ( float  width )

Sets desired boxes width in pixels.

Parameters
width Width of desired boxes
Returns
reference to layer builder

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