ArmNN
 24.08
DetectionPostProcessLayer Class Reference

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

#include <DetectionPostProcessLayer.hpp>

Inheritance diagram for DetectionPostProcessLayer:
[legend]
Collaboration diagram for DetectionPostProcessLayer:
[legend]

Public Member Functions

virtual std::unique_ptr< IWorkloadCreateWorkload (const IWorkloadFactory &factory) const override
 Makes a workload for the DetectionPostProcess type. More...
 
DetectionPostProcessLayerClone (Graph &graph) const override
 Creates a dynamically-allocated copy of this layer. More...
 
void ValidateTensorShapesFromInputs () override
 Check if the input tensor shape(s) will lead to a valid configuration of DetectionPostProcessLayer. More...
 
std::vector< TensorShapeInferOutputShapes (const std::vector< TensorShape > &inputShapes) const override
 The model does not specify the output shapes. More...
 
void ExecuteStrategy (IStrategy &strategy) const override
 Apply a visitor to this layer. More...
 
- Public Member Functions inherited from LayerWithParameters< DetectionPostProcessDescriptor >
const DetectionPostProcessDescriptorGetParameters () const override
 If the layer has a descriptor return it. More...
 
void SerializeLayerParameters (ParameterStringifyFunction &fn) const override
 Helper to serialize the layer parameters to string (currently used in DotSerializer and company). More...
 
- 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 OutputHandlerGetOutputHandler (unsigned int i=0) const
 
OutputHandlerGetOutputHandler (unsigned int i=0)
 
ShapeInferenceMethod GetShapeInferenceMethod () const
 
bool GetAllowExpandedDims () const
 
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 override
 Returns the armnn::LayerType of this layer. More...
 
DataType GetDataType () const
 
const BackendIdGetBackendId () const
 
void SetBackendId (const BackendId &id) override
 Set the backend of the IConnectableLayer. More...
 
virtual void CreateTensorHandles (const TensorHandleFactoryRegistry &registry, const IWorkloadFactory &factory, const bool IsMemoryManaged=true)
 
void VerifyLayerConnections (unsigned int expectedConnections, const CheckLocation &location) const
 
virtual void ReleaseConstantData ()
 
template<typename Op >
void OperateOnConstantTensors (Op op)
 
const char * GetName () const override
 Returns the name of the layer. More...
 
unsigned int GetNumInputSlots () const override
 Returns the number of connectable input slots. More...
 
unsigned int GetNumOutputSlots () const override
 Returns the number of connectable output slots. More...
 
const InputSlotGetInputSlot (unsigned int index) const override
 Get a const input slot handle by slot index. More...
 
InputSlotGetInputSlot (unsigned int index) override
 Get the input slot handle by slot index. More...
 
const OutputSlotGetOutputSlot (unsigned int index=0) const override
 Get the const output slot handle by slot index. More...
 
OutputSlotGetOutputSlot (unsigned int index=0) override
 Get the output slot handle by slot index. More...
 
void SetGuid (LayerGuid guid)
 
LayerGuid GetGuid () const final
 Returns the unique id of the layer. More...
 
void AddRelatedLayerName (const std::string layerName)
 
const std::list< std::string > & GetRelatedLayerNames ()
 
virtual void Reparent (Graph &dest, std::list< Layer * >::const_iterator iterator)=0
 
void BackendSelectionHint (Optional< BackendId > backend) final
 Provide a hint for the optimizer as to which backend to prefer for this layer. More...
 
Optional< BackendIdGetBackendHint () const
 
void SetShapeInferenceMethod (ShapeInferenceMethod shapeInferenceMethod)
 
void SetAllowExpandedDims (bool allowExpandedDims)
 
template<typename T >
std::shared_ptr< T > GetAdditionalInformation () const
 
void SetAdditionalInfoForObject (const AdditionalInfoObjectPtr &additionalInfo)
 
virtual const BaseDescriptorGetParameters () const override
 If the layer has a descriptor return it. More...
 

Public Attributes

std::shared_ptr< ConstTensorHandlem_Anchors
 A unique pointer to store Anchor values. More...
 

Protected Member Functions

 DetectionPostProcessLayer (const DetectionPostProcessDescriptor &param, const char *name)
 Constructor to create a DetectionPostProcessLayer. More...
 
 ~DetectionPostProcessLayer ()=default
 Default destructor. More...
 
ImmutableConstantTensors GetConstantTensorsByRef () const override
 Retrieve the handles to the constant values stored by the layer. More...
 
- 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 *Layer::CreateWorkload. More...
 
void ExecuteStrategy (IStrategy &strategy) const override
 Apply a visitor to this layer. More...
 
Layer::ImmutableConstantTensors GetConnectedConstantAsInputTensors () const
 
- 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
 
void ValidateAndCopyShape (const TensorShape &outputShape, const TensorShape &inferredShape, const ShapeInferenceMethod shapeInferenceMethod, const std::string &layerName, const unsigned int outputSlotIndex=0)
 
void VerifyShapeInferenceType (const TensorShape &outputShape, ShapeInferenceMethod shapeInferenceMethod)
 
template<typename QueueDescriptor >
WorkloadInfo PrepInfoAndDesc (QueueDescriptor &descriptor) const
 Helper function to reduce duplication in *Layer::CreateWorkload. More...
 
template<typename LayerType , typename ... Params>
LayerTypeCloneBase (Graph &graph, Params &&... params) const
 
virtual ConstantTensors GetConstantTensorsByRef () override final
 
void SetAdditionalInfo (QueueDescriptor &descriptor) 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
 
- Public Types inherited from IConnectableLayer
using ConstantTensors = std::vector< std::reference_wrapper< std::shared_ptr< ConstTensorHandle > >>
 
using ImmutableConstantTensors = std::vector< std::reference_wrapper< const std::shared_ptr< ConstTensorHandle > >>
 
- 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
AdditionalInfoObjectPtr m_AdditionalInfoObject
 
std::vector< OutputHandlerm_OutputHandlers
 
ShapeInferenceMethod m_ShapeInferenceMethod
 

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.

20 {
21 }

◆ ~DetectionPostProcessLayer()

~DetectionPostProcessLayer ( )
protecteddefault

Default destructor.

Member Function Documentation

◆ 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 32 of file DetectionPostProcessLayer.cpp.

33 {
34  auto layer = CloneBase<DetectionPostProcessLayer>(graph, m_Param, GetName());
35  layer->m_Anchors = m_Anchors ? m_Anchors : nullptr;
36  return std::move(layer);
37 }

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

◆ 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.

24 {
25  DetectionPostProcessQueueDescriptor descriptor;
26  descriptor.m_Anchors = m_Anchors.get();
27  SetAdditionalInfo(descriptor);
28 
29  return factory.CreateWorkload(LayerType::DetectionPostProcess, descriptor, PrepInfoAndDesc(descriptor));
30 }

References IWorkloadFactory::CreateWorkload(), armnn::DetectionPostProcess, DetectionPostProcessLayer::m_Anchors, DetectionPostProcessQueueDescriptor::m_Anchors, LayerWithParameters< DetectionPostProcessDescriptor >::PrepInfoAndDesc(), and Layer::SetAdditionalInfo().

◆ ExecuteStrategy()

void ExecuteStrategy ( IStrategy strategy) const
overridevirtual

Apply a visitor to this layer.

Reimplemented from Layer.

Definition at line 112 of file DetectionPostProcessLayer.cpp.

113 {
114  ManagedConstTensorHandle managedAnchors(m_Anchors);
115  std::vector<armnn::ConstTensor> constTensors { {managedAnchors.GetTensorInfo(), managedAnchors.Map()} };
116  strategy.ExecuteStrategy(this, GetParameters(), constTensors, GetName());
117 }

References IStrategy::ExecuteStrategy(), Layer::GetName(), LayerWithParameters< DetectionPostProcessDescriptor >::GetParameters(), ManagedConstTensorHandle::GetTensorInfo(), DetectionPostProcessLayer::m_Anchors, and ManagedConstTensorHandle::Map().

◆ GetConstantTensorsByRef()

Layer::ImmutableConstantTensors GetConstantTensorsByRef ( ) const
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 106 of file DetectionPostProcessLayer.cpp.

107 {
108  // For API stability DO NOT ALTER order and add new members to the end of vector
109  return { m_Anchors };
110 }

References DetectionPostProcessLayer::m_Anchors.

◆ InferOutputShapes()

std::vector< TensorShape > InferOutputShapes ( const std::vector< TensorShape > &  inputShapes) const
overridevirtual

The model does not specify the output shapes.

The output shapes are calculated from the max_detection and max_classes_per_detection parameters in the DetectionPostProcessDescriptor.

Parameters
[in]inputShapesThe input shapes layer has. These are ignored for DetectionPostProcessLayer.
Returns
A vector to the inferred output shape.

Reimplemented from Layer.

Definition at line 94 of file DetectionPostProcessLayer.cpp.

95 {
96  unsigned int detectedBoxes = m_Param.m_MaxDetections * m_Param.m_MaxClassesPerDetection;
97 
98  std::vector<TensorShape> results;
99  results.push_back({ 1, detectedBoxes, 4 });
100  results.push_back({ 1, detectedBoxes });
101  results.push_back({ 1, detectedBoxes });
102  results.push_back({ 1 });
103  return results;
104 }

References DetectionPostProcessDescriptor::m_MaxClassesPerDetection, DetectionPostProcessDescriptor::m_MaxDetections, and LayerWithParameters< DetectionPostProcessDescriptor >::m_Param.

Referenced by DetectionPostProcessLayer::ValidateTensorShapesFromInputs().

◆ ValidateTensorShapesFromInputs()

void ValidateTensorShapesFromInputs ( )
overridevirtual

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

Parameters
[in]shapeInferenceMethodIndicates if output shape shall be overwritten or just validated.

Implements Layer.

Definition at line 39 of file DetectionPostProcessLayer.cpp.

40 {
42 
43  const TensorShape& outputShape = GetOutputSlot(0).GetTensorInfo().GetShape();
44 
46 
47  // on this level constant data should not be released.
48  if (!m_Anchors)
49  {
50  throw armnn::LayerValidationException("DetectionPostProcessLayer: Anchors data should not be null.");
51  }
52 
53  if (GetNumOutputSlots() != 4)
54  {
55  throw armnn::LayerValidationException("DetectionPostProcessLayer: The layer should return 4 outputs.");
56  }
57 
58  std::vector<TensorShape> inferredShapes = InferOutputShapes(
61 
62  if (inferredShapes.size() != 4)
63  {
64  throw armnn::LayerValidationException("inferredShapes has "
65  + std::to_string(inferredShapes.size()) +
66  " element(s) - should only have 4.");
67  }
68 
69  if (std::any_of(inferredShapes.begin(), inferredShapes.end(), [] (auto&& inferredShape) {
70  return inferredShape.GetDimensionality() != Dimensionality::Specified;
71  }))
72  {
73  throw armnn::Exception("One of inferredShapes' dimensionalities is not specified.");
74  }
75 
76  ValidateAndCopyShape(outputShape, inferredShapes[0], m_ShapeInferenceMethod, "DetectionPostProcessLayer");
77 
79  inferredShapes[1],
81  "DetectionPostProcessLayer", 1);
82 
84  inferredShapes[2],
86  "DetectionPostProcessLayer", 2);
87 
89  inferredShapes[3],
91  "DetectionPostProcessLayer", 3);
92 }

References CHECK_LOCATION, Layer::GetInputSlot(), Layer::GetNumOutputSlots(), Layer::GetOutputSlot(), TensorInfo::GetShape(), armnn::GetTensorInfo(), InputSlot::GetTensorInfo(), OutputSlot::GetTensorInfo(), DetectionPostProcessLayer::InferOutputShapes(), DetectionPostProcessLayer::m_Anchors, Layer::m_ShapeInferenceMethod, Layer::ValidateAndCopyShape(), Layer::VerifyLayerConnections(), and Layer::VerifyShapeInferenceType().

Member Data Documentation

◆ m_Anchors


The documentation for this class was generated from the following files:
armnn::DetectionPostProcessLayer::InferOutputShapes
std::vector< TensorShape > InferOutputShapes(const std::vector< TensorShape > &inputShapes) const override
The model does not specify the output shapes.
Definition: DetectionPostProcessLayer.cpp:94
armnn::OutputSlot::GetTensorInfo
const TensorInfo & GetTensorInfo() const override
Definition: Layer.cpp:100
armnn::DetectionPostProcessDescriptor::m_MaxDetections
uint32_t m_MaxDetections
Maximum numbers of detections.
Definition: Descriptors.hpp:745
CHECK_LOCATION
#define CHECK_LOCATION()
Definition: Exceptions.hpp:203
armnn::Layer::ValidateAndCopyShape
void ValidateAndCopyShape(const TensorShape &outputShape, const TensorShape &inferredShape, const ShapeInferenceMethod shapeInferenceMethod, const std::string &layerName, const unsigned int outputSlotIndex=0)
Definition: Layer.cpp:457
armnn::Layer::GetOutputSlot
const OutputSlot & GetOutputSlot(unsigned int index=0) const override
Get the const output slot handle by slot index.
Definition: Layer.hpp:339
armnn::DetectionPostProcessDescriptor::m_MaxClassesPerDetection
uint32_t m_MaxClassesPerDetection
Maximum numbers of classes per detection, used in Fast NMS.
Definition: Descriptors.hpp:747
armnn::Layer::GetInputSlot
const InputSlot & GetInputSlot(unsigned int index) const override
Get a const input slot handle by slot index.
Definition: Layer.hpp:337
armnn::LayerWithParameters< DetectionPostProcessDescriptor >::GetParameters
const DetectionPostProcessDescriptor & GetParameters() const override
Definition: LayerWithParameters.hpp:19
armnn::Layer::GetName
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:332
armnn::InputSlot::GetTensorInfo
const TensorInfo & GetTensorInfo() const override
Gets the TensorInfo for this InputSlot.
Definition: Layer.cpp:614
armnn::LayerWithParameters< DetectionPostProcessDescriptor >::m_Param
DetectionPostProcessDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
Definition: LayerWithParameters.hpp:52
armnn::LayerWithParameters< DetectionPostProcessDescriptor >::PrepInfoAndDesc
WorkloadInfo PrepInfoAndDesc(QueueDescriptor &descriptor) const
Helper function to reduce duplication in *Layer::CreateWorkload.
Definition: LayerWithParameters.hpp:44
armnn::LayerValidationException
Definition: Exceptions.hpp:105
armnn::Layer::GetNumOutputSlots
unsigned int GetNumOutputSlots() const override
Returns the number of connectable output slots.
Definition: Layer.hpp:335
armnn::Layer::VerifyShapeInferenceType
void VerifyShapeInferenceType(const TensorShape &outputShape, ShapeInferenceMethod shapeInferenceMethod)
Definition: Layer.cpp:526
armnn::GetTensorInfo
const TensorInfo & GetTensorInfo(const ITensorHandle *tensorHandle)
float32 helpers
Definition: RefWorkloadUtils.hpp:33
armnn::Layer::SetAdditionalInfo
void SetAdditionalInfo(QueueDescriptor &descriptor) const
Definition: Layer.cpp:303
armnn::Exception
Base class for all ArmNN exceptions so that users can filter to just those.
Definition: Exceptions.hpp:46
armnn::LayerType::DetectionPostProcess
@ DetectionPostProcess
armnn::DetectionPostProcessLayer::m_Anchors
std::shared_ptr< ConstTensorHandle > m_Anchors
A unique pointer to store Anchor values.
Definition: DetectionPostProcessLayer.hpp:20
armnn::TensorInfo::GetShape
const TensorShape & GetShape() const
Definition: Tensor.hpp:193
armnn::Layer::VerifyLayerConnections
void VerifyLayerConnections(unsigned int expectedConnections, const CheckLocation &location) const
Definition: Layer.cpp:410
armnn::LayerWithParameters< DetectionPostProcessDescriptor >::LayerWithParameters
LayerWithParameters(unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const DetectionPostProcessDescriptor &param, const char *name)
Definition: LayerWithParameters.hpp:30
armnn::Layer::m_ShapeInferenceMethod
ShapeInferenceMethod m_ShapeInferenceMethod
Definition: Layer.hpp:441