Package org.anchoranalysis.plugin.annotation.bean.strategy

Class ImageLabelStrategy

Object

AnchorBean<AnnotatorStrategy>

AnnotatorStrategy

SinglePathStrategy

ImageLabelStrategy

public class ImageLabelStrategy
extends SinglePathStrategy

Assigns a single label per image, as a whole.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
ImageLabelStrategy()

Method Summary

Modifier and Type	Method	Description
Optional<String>	annotationLabelFor(ProvidesStackInput item, OperationContext context)	A human-friendly textual description of the annotation, or Optional.empty() if no label is available.
List<AnnotationLabel>	getLabels()	List of AnnotationLabels available for annotation.
int	getWeightWidthDescription()	The weight to use for the width of the description.
GroupedAnnotationLabels	groupedLabels()	Creates a GroupedAnnotationLabels from the current labels.
void	setLabels(List<AnnotationLabel> labels)	List of AnnotationLabels available for annotation.
void	setWeightWidthDescription(int weightWidthDescription)	The weight to use for the width of the description.
int	weightWidthDescription()	The degree as to how lengthy the labels from AnnotatorStrategy.annotationLabelFor(ProvidesStackInput, OperationContext) can be.

Methods inherited from class org.anchoranalysis.plugin.annotation.bean.strategy.SinglePathStrategy

getPathAnnotation, pathFor, setPathAnnotation

Methods inherited from class org.anchoranalysis.annotation.io.bean.AnnotatorStrategy

getBackground, getStackReader, setBackground, setStackReader

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

ImageLabelStrategy

public ImageLabelStrategy()

Method Details

annotationLabelFor

public Optional<String> annotationLabelFor(ProvidesStackInput item,
 OperationContext context)
                                    throws OperationFailedException

Description copied from class: AnnotatorStrategy

A human-friendly textual description of the annotation, or Optional.empty() if no label is available.

Specified by:

annotationLabelFor in class AnnotatorStrategy

Parameters:

item - the input to find an annotation label for.

context - the OperationContext for the operation.

Returns:

the label, if available.

Throws:

OperationFailedException - if a label cannot be successfully determined.

groupedLabels

public GroupedAnnotationLabels groupedLabels()

Creates a GroupedAnnotationLabels from the current labels.

This is actually called twice during a typical opening of an annotation. But overhead is minor (assuming not very many labels).

Returns:

a new GroupedAnnotationLabels instance.

weightWidthDescription

public int weightWidthDescription()

Description copied from class: AnnotatorStrategy

The degree as to how lengthy the labels from AnnotatorStrategy.annotationLabelFor(ProvidesStackInput, OperationContext) can be.

The higher the number, the lengthier AnnotatorStrategy.annotationLabelFor(ProvidesStackInput, OperationContext) can be.

Specified by:

weightWidthDescription in class AnnotatorStrategy

Returns:

the weight indicating the potential length of the description.

getLabels

public List<AnnotationLabel> getLabels()

List of AnnotationLabels available for annotation.

setLabels

public void setLabels(List<AnnotationLabel> labels)

List of AnnotationLabels available for annotation.

getWeightWidthDescription

public int getWeightWidthDescription()

The weight to use for the width of the description.

setWeightWidthDescription

public void setWeightWidthDescription(int weightWidthDescription)

The weight to use for the width of the description.