Package org.anchoranalysis.image.bean.spatial.arrange.overlay

Class Overlay

Object

AnchorBean<StackArranger>

StackArranger

Overlay

public class Overlay
extends StackArranger

Overlays one image on the other.

• first image passed is assumed to be the source.
• second image passed is assumed to be the overlay.

We have no Z implemented yet, so we always overlay at z position 0.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
Overlay()
Overlay(String alignX, String alignY, String alignZ)	Creates with alignment text for each axis.
Overlay(Align align)	Creates a new Overlay instance.

Method Summary

Modifier and Type	Method	Description
StackArrangement	arrangeStacks(Iterator<Extent> extents, OperationContext context)	Arranges stacks to that they fit together in a single raster.
String	describeBean()	A (maybe longer) description identifying the bean and perhaps its key parameters.
Align	getAlign()	Indicates how to align the image across the three axes.
void	setAlign(Align align)	Indicates how to align the image across the three axes.

Methods inherited from class org.anchoranalysis.image.bean.spatial.arrange.StackArranger

combine, combine

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, 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

Overlay

public Overlay(String alignX,
 String alignY,
 String alignZ)

Creates with alignment text for each axis.

Parameters:

alignX - indicates how to align the image across the X-axis: one of top, bottom, center.

alignY - indicates how to align the image across the Y-axis (i.e. vertically): one of top, bottom, center.

alignZ - indicates how to align the image across the Z-axis: one of top, bottom, center, repeat. See alignZ.

Overlay

public Overlay()

Overlay

public Overlay(Align align)

Creates a new Overlay instance.

Parameters:

align - Indicates how to align the image across the three axes.

Method Details

describeBean

public String describeBean()

Description copied from class: AnchorBean

A (maybe longer) description identifying the bean and perhaps its key parameters.

By default, it returns the same as AnchorBean.getBeanName() but beans can optionally override it

Overrides:

describeBean in class AnchorBean<StackArranger>

Returns:

either the short-name of the bean, or a longer description

arrangeStacks

public StackArrangement arrangeStacks(Iterator<Extent> extents,
 OperationContext context)
                               throws ArrangeStackException

Description copied from class: StackArranger

Arranges stacks to that they fit together in a single raster.

Specified by:

arrangeStacks in class StackArranger

Parameters:

extents - the size of each respective stack for the arrangement.

context - objects for the operation.

Returns:

bounding-boxes for each respective RGBStack in the unified plane.

Throws:

ArrangeStackException - if a bounding-box cannot be determined for any stack.

getAlign

public Align getAlign()

Indicates how to align the image across the three axes.

setAlign

public void setAlign(Align align)

Indicates how to align the image across the three axes.