Package org.anchoranalysis.image.io.bean.stack.combine

Class WriteText

Object

AnchorBean<StackProvider>

InitializableBean<StackProvider,ImageInitialization>

ImageBean<StackProvider>

BeanProviderAsStackBase<StackProvider,Stack>

StackProvider

WriteText

All Implemented Interfaces:

Provider<Stack>, ProviderAsStack

public class WriteText
extends StackProvider

Creates an image that contains text only.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
WriteText()
WriteText(String text)	Creates the bean to write particular text, otherwise using default settings.

Method Summary

Modifier and Type	Method	Description
Stack	get()	Gets or creates an object of type T.
Provider<Stack>	getRepeatZProvider()	Repeats the generated (2D) string in z, so it's the same z-size as intensityProvider
SizeXY	getSize()	Explicit size of the image the string is draw on.
TextStyle	getStyle()
String	getText()	Text to draw on an image.
boolean	isCreateShort()	When true, text is drawn across all z-slices in the stack. when false, it appears on only one z-slice.
void	setCreateShort(boolean createShort)	When true, text is drawn across all z-slices in the stack. when false, it appears on only one z-slice.
void	setRepeatZProvider(Provider<Stack> repeatZProvider)	Repeats the generated (2D) string in z, so it's the same z-size as intensityProvider
void	setSize(SizeXY size)	Explicit size of the image the string is draw on.
void	setStyle(TextStyle style)
void	setText(String text)	Text to draw on an image.

Methods inherited from class org.anchoranalysis.image.bean.provider.stack.StackProvider

getAsStack

Methods inherited from class org.anchoranalysis.bean.initializable.InitializableBean

getInitialization, getLogger, getPropertyInitializer, initialize, initializeRecursive, initRecursiveWithInitializer, isInitialized, onInitialization

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

WriteText

public WriteText(String text)

Creates the bean to write particular text, otherwise using default settings.

Parameters:

text - the text to write.

WriteText

public WriteText()

Method Details

get

public Stack get()
          throws ProvisionFailedException

Description copied from interface: Provider

Gets or creates an object of type T.

Returns:

the object returned by the provider.

Throws:

ProvisionFailedException - if the object cannot be returned.

getText

public String getText()

Text to draw on an image.

setText

public void setText(String text)

Text to draw on an image.

getStyle

public TextStyle getStyle()

setStyle

public void setStyle(TextStyle style)

getSize

public SizeXY getSize()

Explicit size of the image the string is draw on.

setSize

public void setSize(SizeXY size)

Explicit size of the image the string is draw on.

isCreateShort

public boolean isCreateShort()

When true, text is drawn across all z-slices in the stack. when false, it appears on only one z-slice.

setCreateShort

public void setCreateShort(boolean createShort)

When true, text is drawn across all z-slices in the stack. when false, it appears on only one z-slice.

getRepeatZProvider

public Provider<Stack> getRepeatZProvider()

Repeats the generated (2D) string in z, so it's the same z-size as intensityProvider

setRepeatZProvider

public void setRepeatZProvider(Provider<Stack> repeatZProvider)

Repeats the generated (2D) string in z, so it's the same z-size as intensityProvider