public abstract class AnnotatorStrategy extends AnchorBean<AnnotatorStrategy>
This class gives instructions on how to present the annotations process visually.
Constructor and Description |
---|
AnnotatorStrategy() |
Modifier and Type | Method and Description |
---|---|
abstract Optional<String> |
annotationLabelFor(ProvidesStackInput input,
OperationContext context)
A human-friendly textual description of the annotation, or
Optional.empty() if no
label is available. |
AnnotationBackground |
getBackground()
The visual background to use while annotating.
|
StackReader |
getStackReader()
How to read raster
Stack s from the file-system. |
abstract Path |
pathFor(ProvidesStackInput input)
The path to where an annotation file for a particular input would be located.
|
void |
setBackground(AnnotationBackground background)
The visual background to use while annotating.
|
void |
setStackReader(StackReader stackReader)
How to read raster
Stack s from the file-system. |
abstract int |
weightWidthDescription()
The degree as to how lengthy the labels from
annotationLabelFor(ProvidesStackInput,
OperationContext) can be. |
checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString
public abstract Path pathFor(ProvidesStackInput input) throws OperationFailedException
If the annotation is stored on multiple files, this refers to the principle file that must be unique.
input
- the input to find an annotation file for.OperationFailedException
- if the path cannot be successfully determined.public abstract Optional<String> annotationLabelFor(ProvidesStackInput input, OperationContext context) throws OperationFailedException
Optional.empty()
if no
label is available.input
- the input to find an annotation label for.context
- TODOOperationFailedException
- if a label cannot be successfully determined.public abstract int weightWidthDescription()
annotationLabelFor(ProvidesStackInput,
OperationContext)
can be.
The higher the number, the lengthier annotationLabelFor(ProvidesStackInput,
OperationContext)
can be.
public AnnotationBackground getBackground()
public void setBackground(AnnotationBackground background)
public StackReader getStackReader()
Stack
s from the file-system.public void setStackReader(StackReader stackReader)
Stack
s from the file-system.Copyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.