ArmNN  NotReleased
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
DetectionPostProcessLayer Class Reference

This layer represents a detection postprocess operator. More...

#include <DetectionPostProcessLayer.hpp>

Inheritance diagram for DetectionPostProcessLayer:
LayerWithParameters< DetectionPostProcessDescriptor > Layer IConnectableLayer

Public Member Functions

virtual std::unique_ptr< IWorkload > CreateWorkload (const IWorkloadFactory &factory) const override
 
DetectionPostProcessLayer * Clone (Graph &graph) const override
 
void ValidateTensorShapesFromInputs () override
 
void Accept (ILayerVisitor &visitor) const override
 
- Public Member Functions inherited from LayerWithParameters< DetectionPostProcessDescriptor >
const DetectionPostProcessDescriptor & GetParameters () const
 
void SerializeLayerParameters (ParameterStringifyFunction &fn) const override
 
- Public Member Functions inherited from Layer
 Layer (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const char *name)
 
 Layer (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, DataLayout layout, const char *name)
 
const std::string & GetNameStr () const
 
const OutputHandler & GetOutputHandler (unsigned int i=0) const
 
OutputHandler & GetOutputHandler (unsigned int i=0)
 
const std::vector< InputSlot > & GetInputSlots () const
 
const std::vector< OutputSlot > & GetOutputSlots () const
 
std::vector< InputSlot >::iterator BeginInputSlots ()
 
std::vector< InputSlot >::iterator EndInputSlots ()
 
std::vector< OutputSlot >::iterator BeginOutputSlots ()
 
std::vector< OutputSlot >::iterator EndOutputSlots ()
 
bool IsOutputUnconnected ()
 
void ResetPriority () const
 
LayerPriority GetPriority () const
 
LayerType GetType () const
 
DataType GetDataType () const
 
const BackendId & GetBackendId () const
 
void SetBackendId (const BackendId &id)
 
virtual void CreateTensorHandles (const TensorHandleFactoryRegistry &registry, const IWorkloadFactory &factory, const bool IsMemoryManaged=true)
 
void VerifyLayerConnections (unsigned int expectedConnections, const CheckLocation &location) const
 
std::vector< TensorShape > InferOutputShapes (const std::vector< TensorShape > &inputShapes) const override
 
virtual void ReleaseConstantData ()
 
template<typename Op >
void OperateOnConstantTensors (Op op)
 
const char * GetName () const override
 
unsigned int GetNumInputSlots () const override
 
unsigned int GetNumOutputSlots () const override
 
const InputSlot & GetInputSlot (unsigned int index) const override
 
InputSlot & GetInputSlot (unsigned int index) override
 
const OutputSlot & GetOutputSlot (unsigned int index=0) const override
 
OutputSlot & GetOutputSlot (unsigned int index=0) override
 
void SetGuid (LayerGuid guid)
 
LayerGuid GetGuid () const final
 
void AddRelatedLayerName (const std::string layerName)
 
const std::list< std::string > & GetRelatedLayerNames ()
 
virtual void Reparent (Graph &dest, std::list< Layer *>::const_iterator iterator)=0
 

Public Attributes

std::unique_ptr< ScopedCpuTensorHandle > m_Anchors
 A unique pointer to store Anchor values. More...
 

Protected Member Functions

 DetectionPostProcessLayer (const DetectionPostProcessDescriptor &param, const char *name)
 
 ~DetectionPostProcessLayer ()=default
 Default destructor. More...
 
ConstantTensors GetConstantTensorsByRef () override
 
- Protected Member Functions inherited from LayerWithParameters< DetectionPostProcessDescriptor >
 LayerWithParameters (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const DetectionPostProcessDescriptor &param, const char *name)
 
 ~LayerWithParameters ()=default
 
WorkloadInfo PrepInfoAndDesc (QueueDescriptor &descriptor) const
 Helper function to reduce duplication in *LayerCreateWorkload. More...
 
- Protected Member Functions inherited from Layer
virtual ~Layer ()=default
 
template<typename QueueDescriptor >
void CollectQueueDescriptorInputs (QueueDescriptor &descriptor, WorkloadInfo &info) const
 
template<typename QueueDescriptor >
void CollectQueueDescriptorOutputs (QueueDescriptor &descriptor, WorkloadInfo &info) const
 
template<typename QueueDescriptor >
WorkloadInfo PrepInfoAndDesc (QueueDescriptor &descriptor) const
 Helper function to reduce duplication in *LayerCreateWorkload. More...
 
template<typename LayerType , typename ... Params>
LayerType * CloneBase (Graph &graph, Params &&... params) const
 
- Protected Member Functions inherited from IConnectableLayer
 ~IConnectableLayer ()
 Objects are not deletable via the handle. More...
 

Additional Inherited Members

- Public Types inherited from LayerWithParameters< DetectionPostProcessDescriptor >
using DescriptorType = DetectionPostProcessDescriptor
 
- Protected Types inherited from Layer
using ConstantTensors = std::vector< std::reference_wrapper< std::unique_ptr< ScopedCpuTensorHandle > >>
 
- Protected Attributes inherited from LayerWithParameters< DetectionPostProcessDescriptor >
DetectionPostProcessDescriptor m_Param
 The parameters for the layer (not including tensor-valued weights etc.). More...
 
- Protected Attributes inherited from Layer
std::vector< OutputHandler > m_OutputHandlers
 

Detailed Description

This layer represents a detection postprocess operator.

Definition at line 16 of file DetectionPostProcessLayer.hpp.

Constructor & Destructor Documentation

◆ DetectionPostProcessLayer()

DetectionPostProcessLayer ( const DetectionPostProcessDescriptor &  param,
const char *  name 
)
protected

Constructor to create a DetectionPostProcessLayer.

Parameters
[in]paramDetectionPostProcessDescriptor to configure the detection postprocess.
[in]nameOptional name for the layer.

Definition at line 18 of file DetectionPostProcessLayer.cpp.

19  : LayerWithParameters(2, 4, LayerType::DetectionPostProcess, param, name)
20 {
21 }
armnn::LayerWithParameters< DetectionPostProcessDescriptor >::LayerWithParameters
LayerWithParameters(unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const DetectionPostProcessDescriptor &param, const char *name)
Definition: LayerWithParameters.hpp:29

◆ ~DetectionPostProcessLayer()

~DetectionPostProcessLayer ( )
protecteddefault

Default destructor.

Member Function Documentation

◆ Accept()

void Accept ( ILayerVisitor &  visitor) const
overridevirtual

Implements IConnectableLayer.

Definition at line 75 of file DetectionPostProcessLayer.cpp.

References Layer::GetName(), LayerWithParameters< DetectionPostProcessDescriptor >::GetParameters(), DetectionPostProcessLayer::m_Anchors, and ILayerVisitor::VisitDetectionPostProcessLayer().

76 {
77  ConstTensor anchorTensor(m_Anchors->GetTensorInfo(), m_Anchors->GetConstTensor<void>());
78  visitor.VisitDetectionPostProcessLayer(this, GetParameters(), anchorTensor, GetName());
79 }
armnn::DetectionPostProcessLayer::m_Anchors
std::unique_ptr< ScopedCpuTensorHandle > m_Anchors
A unique pointer to store Anchor values.
Definition: DetectionPostProcessLayer.hpp:20
armnn::Layer::GetName
const char * GetName() const override
Definition: Layer.hpp:305
armnn::LayerWithParameters< DetectionPostProcessDescriptor >::GetParameters
const DetectionPostProcessDescriptor & GetParameters() const
Definition: LayerWithParameters.hpp:18

◆ Clone()

DetectionPostProcessLayer * Clone ( Graph &  graph) const
overridevirtual

Creates a dynamically-allocated copy of this layer.

Parameters
[in]graphThe graph into which this layer is being cloned.

Implements Layer.

Definition at line 30 of file DetectionPostProcessLayer.cpp.

References Layer::GetName(), DetectionPostProcessLayer::m_Anchors, and LayerWithParameters< DetectionPostProcessDescriptor >::m_Param.

31 {
32  auto layer = CloneBase<DetectionPostProcessLayer>(graph, m_Param, GetName());
33  layer->m_Anchors = m_Anchors ? std::make_unique<ScopedCpuTensorHandle>(*m_Anchors) : nullptr;
34  return std::move(layer);
35 }
armnn::DetectionPostProcessLayer::m_Anchors
std::unique_ptr< ScopedCpuTensorHandle > m_Anchors
A unique pointer to store Anchor values.
Definition: DetectionPostProcessLayer.hpp:20
armnn::Layer::GetName
const char * GetName() const override
Definition: Layer.hpp:305
armnn::LayerWithParameters< DetectionPostProcessDescriptor >::m_Param
DetectionPostProcessDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
Definition: LayerWithParameters.hpp:50

◆ CreateWorkload()

std::unique_ptr< IWorkload > CreateWorkload ( const IWorkloadFactory &  factory) const
overridevirtual

Makes a workload for the DetectionPostProcess type.

Parameters
[in]graphThe graph where this layer can be found.
[in]factoryThe workload factory which will create the workload.
Returns
A pointer to the created workload, or nullptr if not created.

Implements Layer.

Definition at line 23 of file DetectionPostProcessLayer.cpp.

References IWorkloadFactory::CreateDetectionPostProcess(), DetectionPostProcessLayer::m_Anchors, DetectionPostProcessQueueDescriptor::m_Anchors, and LayerWithParameters< DetectionPostProcessDescriptor >::PrepInfoAndDesc().

24 {
25  DetectionPostProcessQueueDescriptor descriptor;
26  descriptor.m_Anchors = m_Anchors.get();
27  return factory.CreateDetectionPostProcess(descriptor, PrepInfoAndDesc(descriptor));
28 }
armnn::DetectionPostProcessLayer::m_Anchors
std::unique_ptr< ScopedCpuTensorHandle > m_Anchors
A unique pointer to store Anchor values.
Definition: DetectionPostProcessLayer.hpp:20
armnn::LayerWithParameters< DetectionPostProcessDescriptor >::PrepInfoAndDesc
WorkloadInfo PrepInfoAndDesc(QueueDescriptor &descriptor) const
Helper function to reduce duplication in *LayerCreateWorkload.
Definition: LayerWithParameters.hpp:43

◆ GetConstantTensorsByRef()

Layer::ConstantTensors GetConstantTensorsByRef ( )
overrideprotectedvirtual

Retrieve the handles to the constant values stored by the layer.

Returns
A vector of the constant tensors stored by this layer.

Reimplemented from Layer.

Definition at line 70 of file DetectionPostProcessLayer.cpp.

References DetectionPostProcessLayer::m_Anchors.

71 {
72  return { m_Anchors };
73 }
armnn::DetectionPostProcessLayer::m_Anchors
std::unique_ptr< ScopedCpuTensorHandle > m_Anchors
A unique pointer to store Anchor values.
Definition: DetectionPostProcessLayer.hpp:20

◆ ValidateTensorShapesFromInputs()

void ValidateTensorShapesFromInputs ( )
overridevirtual

Check if the input tensor shape(s) will lead to a valid configuration of DetectionPostProcessLayer.

Implements Layer.

Definition at line 37 of file DetectionPostProcessLayer.cpp.

References CHECK_LOCATION, Layer::GetNumOutputSlots(), Layer::GetOutputSlot(), TensorInfo::GetShape(), OutputSlot::GetTensorInfo(), DetectionPostProcessLayer::m_Anchors, DetectionPostProcessDescriptor::m_MaxClassesPerDetection, DetectionPostProcessDescriptor::m_MaxDetections, LayerWithParameters< DetectionPostProcessDescriptor >::m_Param, and Layer::VerifyLayerConnections().

38 {
39  VerifyLayerConnections(2, CHECK_LOCATION());
40 
41  // on this level constant data should not be released.
42  BOOST_ASSERT_MSG(m_Anchors != nullptr, "DetectionPostProcessLayer: Anchors data should not be null.");
43 
44  BOOST_ASSERT_MSG(GetNumOutputSlots() == 4, "DetectionPostProcessLayer: The layer should return 4 outputs.");
45 
46  unsigned int detectedBoxes = m_Param.m_MaxDetections * m_Param.m_MaxClassesPerDetection;
47 
48  const TensorShape& inferredDetectionBoxes = TensorShape({ 1, detectedBoxes, 4 });
49  const TensorShape& inferredDetectionScores = TensorShape({ 1, detectedBoxes });
50  const TensorShape& inferredNumberDetections = TensorShape({ 1 });
51 
52  ConditionalThrowIfNotEqual<LayerValidationException>(
53  "DetectionPostProcessLayer: TensorShape set on OutputSlot[0] does not match the inferred shape.",
54  GetOutputSlot(0).GetTensorInfo().GetShape(),
55  inferredDetectionBoxes);
56  ConditionalThrowIfNotEqual<LayerValidationException>(
57  "DetectionPostProcessLayer: TensorShape set on OutputSlot[1] does not match the inferred shape.",
58  GetOutputSlot(1).GetTensorInfo().GetShape(),
59  inferredDetectionScores);
60  ConditionalThrowIfNotEqual<LayerValidationException>(
61  "DetectionPostProcessLayer: TensorShape set on OutputSlot[2] does not match the inferred shape.",
62  GetOutputSlot(2).GetTensorInfo().GetShape(),
63  inferredDetectionScores);
64  ConditionalThrowIfNotEqual<LayerValidationException>(
65  "DetectionPostProcessLayer: TensorShape set on OutputSlot[3] does not match the inferred shape.",
66  GetOutputSlot(3).GetTensorInfo().GetShape(),
67  inferredNumberDetections);
68 }
armnn::DetectionPostProcessLayer::m_Anchors
std::unique_ptr< ScopedCpuTensorHandle > m_Anchors
A unique pointer to store Anchor values.
Definition: DetectionPostProcessLayer.hpp:20
armnn::Layer::GetNumOutputSlots
unsigned int GetNumOutputSlots() const override
Definition: Layer.hpp:308
armnn::DetectionPostProcessDescriptor::m_MaxClassesPerDetection
uint32_t m_MaxClassesPerDetection
Maximum numbers of classes per detection, used in Fast NMS.
Definition: Descriptors.hpp:529
CHECK_LOCATION
#define CHECK_LOCATION()
Definition: Exceptions.hpp:169
armnn::LayerWithParameters< DetectionPostProcessDescriptor >::m_Param
DetectionPostProcessDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
Definition: LayerWithParameters.hpp:50
armnn::Layer::VerifyLayerConnections
void VerifyLayerConnections(unsigned int expectedConnections, const CheckLocation &location) const
Definition: Layer.cpp:337
armnn::TensorInfo::GetShape
const TensorShape & GetShape() const
Definition: Tensor.hpp:88
armnn::OutputSlot::GetTensorInfo
const TensorInfo & GetTensorInfo() const override
Definition: Layer.cpp:63
armnn::Layer::GetOutputSlot
const OutputSlot & GetOutputSlot(unsigned int index=0) const override
Definition: Layer.hpp:312
armnn::DetectionPostProcessDescriptor::m_MaxDetections
uint32_t m_MaxDetections
Maximum numbers of detections.
Definition: Descriptors.hpp:527

Member Data Documentation

◆ m_Anchors

std::unique_ptr<ScopedCpuTensorHandle> m_Anchors

A unique pointer to store Anchor values.

Definition at line 20 of file DetectionPostProcessLayer.hpp.

Referenced by DetectionPostProcessLayer::Accept(), Network::AddDetectionPostProcessLayer(), BOOST_AUTO_TEST_CASE(), DetectionPostProcessLayer::Clone(), DetectionPostProcessLayer::CreateWorkload(), DetectionPostProcessLayer::GetConstantTensorsByRef(), and DetectionPostProcessLayer::ValidateTensorShapesFromInputs().

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