Package org.anchoranalysis.plugin.annotation.bean.aggregate

Class AggregateAnnotations<S extends AnnotatorStrategy>

Object

AnchorBean<Task<AnnotationWithStrategy<S>,AggregateSharedState>>

Task<AnnotationWithStrategy<S>,AggregateSharedState>

AggregateAnnotations<S>

Type Parameters:

S - the type of AnnotatorStrategy used for annotation

public class AggregateAnnotations<S extends AnnotatorStrategy>
extends Task<AnnotationWithStrategy<S>,AggregateSharedState>

Aggregates many per-image annotations together in form of a CSV file.

The following outputs are produced:

Output Name	Default?	Description
"aggregated"	yes	a CSV file with each image and corresponding image-label.
outputs from Task

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
AggregateAnnotations()

Method Summary

Modifier and Type	Method	Description
void	afterAllJobsAreExecuted(AggregateSharedState sharedState, InputOutputContext context)	Called once after all calls to Task.executeJob(org.anchoranalysis.experiment.task.ParametersUnbound<T, S>).
AggregateSharedState	beforeAnyJobIsExecuted(Outputter outputter, ConcurrencyPlan concurrencyPlan, List<AnnotationWithStrategy<S>> inputs, ParametersExperiment parameters)	Called once before all calls to Task.executeJob(org.anchoranalysis.experiment.task.ParametersUnbound<T, S>).
OutputEnabledMutable	defaultOutputs()	If specified, default rules for determine which outputs are enabled or not.
void	doJobOnInput(InputBound<AnnotationWithStrategy<S>,AggregateSharedState> input)	Performs the task on a particular input.
boolean	hasVeryQuickPerInputExecution()	Is the execution-time of the task per-input expected to be very quick to execute?
InputTypesExpected	inputTypesExpected()	Highest class(es) that will function as a valid input.

Methods inherited from class org.anchoranalysis.experiment.bean.task.Task

executeJob, isInputCompatibleWith

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AggregateAnnotations

public AggregateAnnotations()

Method Details

beforeAnyJobIsExecuted

public AggregateSharedState beforeAnyJobIsExecuted(Outputter outputter,
 ConcurrencyPlan concurrencyPlan,
 List<AnnotationWithStrategy<S>> inputs,
 ParametersExperiment parameters)
                                            throws ExperimentExecutionException

Description copied from class: Task

Called once before all calls to Task.executeJob(org.anchoranalysis.experiment.task.ParametersUnbound<T, S>).

Specified by:

beforeAnyJobIsExecuted in class Task<AnnotationWithStrategy<S extends AnnotatorStrategy>,AggregateSharedState>

Parameters:

outputter - the output-manager for the experiment (not for an individual job)

concurrencyPlan - available numbers of processors that can call Task.executeJob(org.anchoranalysis.experiment.task.ParametersUnbound<T, S>)

inputs - a list of inputs, each will result in at least one call to Task.executeJob(ParametersUnbound).

parameters - the experiment-parameters.

Returns:

the shared-state that is passed to each call to Task.executeJob(org.anchoranalysis.experiment.task.ParametersUnbound<T, S>) and to Task.afterAllJobsAreExecuted(S, org.anchoranalysis.io.output.outputter.InputOutputContext).

Throws:

ExperimentExecutionException - if a fatal error occurs executing this step of the experiment.

doJobOnInput

public void doJobOnInput(InputBound<AnnotationWithStrategy<S>,AggregateSharedState> input)
                  throws JobExecutionException

Description copied from class: Task

Performs the task on a particular input.

Specified by:

doJobOnInput in class Task<AnnotationWithStrategy<S extends AnnotatorStrategy>,AggregateSharedState>

Parameters:

input - the input for the job.

Throws:

JobExecutionException - if an error occurs executing a particular job, that is not otherwise suppressed.

afterAllJobsAreExecuted

public void afterAllJobsAreExecuted(AggregateSharedState sharedState,
 InputOutputContext context)
                             throws ExperimentExecutionException

Description copied from class: Task

Called once after all calls to Task.executeJob(org.anchoranalysis.experiment.task.ParametersUnbound<T, S>).

Specified by:

afterAllJobsAreExecuted in class Task<AnnotationWithStrategy<S extends AnnotatorStrategy>,AggregateSharedState>

Parameters:

sharedState - the shared-state

context - IO-context for experiment (not for an individual job)

Throws:

ExperimentExecutionException - if a fatal error occurs executing this step of the experiment.

hasVeryQuickPerInputExecution

public boolean hasVeryQuickPerInputExecution()

Description copied from class: Task

Is the execution-time of the task per-input expected to be very quick to execute?

Specified by:

hasVeryQuickPerInputExecution in class Task<AnnotationWithStrategy<S extends AnnotatorStrategy>,AggregateSharedState>

Returns:

true iff the execution is expected to be very quick, false otherwise.

inputTypesExpected

public InputTypesExpected inputTypesExpected()

Description copied from class: Task

Highest class(es) that will function as a valid input.

This is usually the class of T (or sometimes the absolute base class InputFromManager).

Specified by:

inputTypesExpected in class Task<AnnotationWithStrategy<S extends AnnotatorStrategy>,AggregateSharedState>

Returns:

the input-types that a task expects.

defaultOutputs

public OutputEnabledMutable defaultOutputs()

Description copied from class: Task

If specified, default rules for determine which outputs are enabled or not.

Overrides:

defaultOutputs in class Task<AnnotationWithStrategy<S extends AnnotatorStrategy>,AggregateSharedState>

Returns:

the default rules if they exist.