RFTester Tool for automated testing relevance feedback algorithms fro known-item search

Public Member Functions | Public Attributes | Properties | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
RFTesterBackend.Evaluator.EvaluationTask Class Reference

Task contains instances of implementations of key evaluation components. More...

## Public Member Functions
| EvaluationTask (EvaluationTarget evaluationTarget, EvaluationClass evalClass)
void | Evaluate ()
| Runs the simulation of search. More...

## Public Attributes
EvaluationClass | evalClass
| Master evaluation class. More...

## Properties
IRanker | Ranker`[get, set]`
IDisplayGenerator | DisplayGenerator`[get, set]`
IUser | User`[get, set]`
IMeasurer | Measurer`[get, set]`
IInitializer | Initializer`[get, set]`
List< int > | TargetScene`[get]`
| Target scene which is being searched. More...
int | MaxRounds`[get]`
| Number of max displays. More...
bool | VerboseSearch`[get]`
| Indicator of debugging verbose search. More...
int | TaskNumber`[get, set]`
| Unique number of task within process. More...
bool | ResultsReady`[get, set]`
| Indicator whether results are ready. More...
EvaluationTaskResult | Result`[get, set]`
| Results structure of evaluation task. More...
List< int > | FirstDisplay`[get]`
| First display to show to user. More...
EvaluationTarget | Target`[get, set]`

## Private Member Functions
bool | CheckDisplay (List< int > display, int screenNumber, double[] scores)
| Checks display, fills result and returns whether searching shall end. More...
bool | DisplayContainsTarget (List< int > display)
| Checks display if contains target image. More...
bool | ContainsImageFromVideo (List< int > display)
| Checks display if contains target video. More...
bool | ContainsImageFromShot (List< int > display)
| Checks display if contains target shot. More...

## Private Attributes
IRanker | ranker
| Implementation of ranker. More...
IDisplayGenerator | displayGenerator
| Implementation of display generator. More...
IUser | user
| Implementation of simulated user. More...
IMeasurer | measurer
| Implementation of measurer. More...
IInitializer | initializer
| Implementation of initializer. More...
EvaluationTarget | target
| Structure for evaluation target. More...

## Static Private Attributes
static log4net.ILog | logger = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType)

## Detailed Description

Task contains instances of implementations of key evaluation components.

Runs the basic simulation.

## Constructor & Destructor Documentation

## ◆ EvaluationTask()

RFTesterBackend.Evaluator.EvaluationTask.EvaluationTask | ( | EvaluationTarget | evaluationTarget,
|  | EvaluationClass | evalClass
| ) |  |
| inline

## Member Function Documentation

## ◆ CheckDisplay()

bool RFTesterBackend.Evaluator.EvaluationTask.CheckDisplay | ( | List< int > | display,
|  | int | screenNumber,
|  | double[] | scores
| ) |  |
| inlineprivate

Checks display, fills result and returns whether searching shall end.

Parameters

  display |
  screenNumber |
  scores |

Returns

## ◆ ContainsImageFromShot()

bool RFTesterBackend.Evaluator.EvaluationTask.ContainsImageFromShot | ( | List< int > | display | ) |
| inlineprivate

Checks display if contains target shot.

Parameters

  display |

Returns

## ◆ ContainsImageFromVideo()

bool RFTesterBackend.Evaluator.EvaluationTask.ContainsImageFromVideo | ( | List< int > | display | ) |
| inlineprivate

Checks display if contains target video.

Parameters

  display |

Returns

## ◆ DisplayContainsTarget()

bool RFTesterBackend.Evaluator.EvaluationTask.DisplayContainsTarget | ( | List< int > | display | ) |
| inlineprivate

Checks display if contains target image.

Parameters

  display |

Returns

## ◆ Evaluate()

void RFTesterBackend.Evaluator.EvaluationTask.Evaluate | ( |  | ) |
| inline

Runs the simulation of search.

## Member Data Documentation

## ◆ displayGenerator

IDisplayGenerator RFTesterBackend.Evaluator.EvaluationTask.displayGenerator
| private

Implementation of display generator.

## ◆ evalClass

EvaluationClass RFTesterBackend.Evaluator.EvaluationTask.evalClass

Master evaluation class.

## ◆ initializer

IInitializer RFTesterBackend.Evaluator.EvaluationTask.initializer
| private

Implementation of initializer.

## ◆ logger

log4net.ILog RFTesterBackend.Evaluator.EvaluationTask.logger = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType)
| staticprivate

## ◆ measurer

IMeasurer RFTesterBackend.Evaluator.EvaluationTask.measurer
| private

Implementation of measurer.

## ◆ ranker

IRanker RFTesterBackend.Evaluator.EvaluationTask.ranker
| private

Implementation of ranker.

## ◆ target

EvaluationTarget RFTesterBackend.Evaluator.EvaluationTask.target
| private

Structure for evaluation target.

## ◆ user

IUser RFTesterBackend.Evaluator.EvaluationTask.user
| private

Implementation of simulated user.

## Property Documentation

## ◆ DisplayGenerator

IDisplayGenerator RFTesterBackend.Evaluator.EvaluationTask.DisplayGenerator
| getset

## ◆ FirstDisplay

List<int> RFTesterBackend.Evaluator.EvaluationTask.FirstDisplay
| get

First display to show to user.

## ◆ Initializer

IInitializer RFTesterBackend.Evaluator.EvaluationTask.Initializer
| getset

## ◆ MaxRounds

int RFTesterBackend.Evaluator.EvaluationTask.MaxRounds
| getprivate

Number of max displays.

## ◆ Measurer

IMeasurer RFTesterBackend.Evaluator.EvaluationTask.Measurer
| getset

## ◆ Ranker

IRanker RFTesterBackend.Evaluator.EvaluationTask.Ranker
| getset

## ◆ Result

EvaluationTaskResult RFTesterBackend.Evaluator.EvaluationTask.Result
| getset

Results structure of evaluation task.

## ◆ ResultsReady

bool RFTesterBackend.Evaluator.EvaluationTask.ResultsReady
| getset

Indicator whether results are ready.

## ◆ Target

EvaluationTarget RFTesterBackend.Evaluator.EvaluationTask.Target
| getset

## ◆ TargetScene

List<int> RFTesterBackend.Evaluator.EvaluationTask.TargetScene
| getprivate

Target scene which is being searched.

At the moment we are looking for only one target image.

## ◆ TaskNumber

int RFTesterBackend.Evaluator.EvaluationTask.TaskNumber
| getset

Unique number of task within process.

## ◆ User

IUser RFTesterBackend.Evaluator.EvaluationTask.User
| getset

## ◆ VerboseSearch

bool RFTesterBackend.Evaluator.EvaluationTask.VerboseSearch
| getprivate

Indicator of debugging verbose search.

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

- RFTesterBackend/Evaluator/EvaluationTask.cs