Polarith AI
1.8
PlanarConvolution Class Reference

Description

PlanarConvolution modifies an objective value based on its neighbours (back-end class).

It provides the possibility to modify a Problem<T>.Objective with a convolution matrix named kernel. This might be required in order to smooth the Problem<T>.Objective, for example, with a GaussianKernel.

In its concrete implementation of Behave, the objective values are modified by weighting its neighbours. In contrast to the SteeringBehaviour, you can modify more than one Problem<T>.Objective in order to avoid an unnecessary extra Component. For that, a List<T> of type int can be set. Its entries correspond to the desired target objectives in Context. Note, you must pay attention to the size of the kernel if you set it directly. The kernel size must be odd and greater than two. Optionally, a 'Gaussian' kernel can be computed with ComputeGaussianKernel(int, float).

Back-end class of AIMPlanarConvolution. This behaviour is thread-safe.

Inheritance diagram for PlanarConvolution:
MoveBehaviour CriteriaBehaviour IBehaviour

Public Fields

List< int > TargetObjectives = new List<int>()
 The entries of this list determines the Problem<T>.Objective instances in Context which are modified. More...
 
Context Context
 Reference for quick access to the associated context instance. More...
 
const int CentralOrder = 1000
 The minimum Order for behaviours which should be processed before behaviours using LastOrder but after all other behaviours. More...
 
const int LastOrder = 2000
 The minimum Order for behaviours which should be processed at last. More...
 

Protected Fields

Problem intermediate = new Problem()
 Holds the intermediate result of this behaviour which can be applied to the context map at the end of an update step using BlendValues(LayerBlendingType, int). More...
 
bool enabled
 Determines if this IBehaviour is active or inactive. More...
 

Properties

List< float > Kernel [get, set]
 Represents a discrete kernel. More...
 
bool Enabled [get, set]
 Determines if this IBehaviour is active or inactive. More...
 
int Order [get, set]
 Specifies the execution order of this behaviour. More...
 

Public Methods

override void Behave ()
 This method executes the main algorithm of this behaviour and is called within Context.Evaluate in order to set/modify objective values for the associated Context.Problem. More...
 
void ComputeGaussianKernel (int kernelSize, float sigma)
 This method computes a 'Gaussian' kernel. More...
 

Public Static Methods

static float MapSpecial (MappingType mapping, float min, float max, float value)
 Maps a value lying between min and max to a resulting value between 0 and 1. More...
 
static float MapSpecialSqr (MappingType mapping, float sqrMin, float sqrMax, float sqrValue)
 Maps a sqrValue lying between sqrMin and sqrMax to a resulting value between 0 and 1, whereby all the given parameters are expected to be squared. More...
 

Protected Methods

float MapBySensitivity (MappingType mapping, Structure structure, Vector3 direction, float sensitivityOffset=0.0f)
 Maps (magnitude) values by sensitivity so that the Structure.Sensitivity (plus the given sensitivityOffset ) is used as similarity threshold for the angle between the given direction and the Structure.Direction. More...
 
float MapBySensitivityPlane (MappingType mapping, Structure structure, Vector3 planeDirection1, Vector3 planeDirection2, float offset, float sensitivityOffset=0.0f)
 Maps (magnitude) values by sensitivity so that the Structure.Sensitivity (plus the given sensitivityOffset ) is used as similarity threshold for the smallest angle between a plane defined by planeDirection1 , planeDirection2 and the Structure.Direction. More...
 
void WriteValue (ValueWritingType valueWriting, int objectiveIndex, int valueIndex, float value, bool intermediate=false)
 Writes objective values to the Context.Problem as specified with valueWriting . More...
 
void BlendValues (LayerBlendingType layerBlending, int objectiveIndex)
 Writes the values of the intermediate to the actual Context.Problem. More...
 
Imprint