Package org.anchoranalysis.plugin.image.bean.channel.provider.mask

Class FromMaskBase

Object

AnchorBean<ChannelProvider>

InitializableBean<ChannelProvider,ImageInitialization>

ImageBean<ChannelProvider>

BeanProviderAsStackBase<ChannelProvider,Channel>

ChannelProvider

FromMaskBase

All Implemented Interfaces:

Provider<Channel>, ProviderAsStack

Direct Known Subclasses:

DistanceTransform3D, FromMask

public abstract class FromMaskBase
extends ChannelProvider

A base class for a ChannelProvider which also uses a binary-mask, but which doesn't use any other ChannelProvider as an input.

Note for classes that use both a binary-mask AND another ChannelProvider, see UnaryWithMaskBase.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
FromMaskBase()

Method Summary

Modifier and Type	Method	Description
protected abstract Channel	createFromMask(Mask mask)	Creates a Channel from the provided Mask.
Channel	get()	Gets or creates an object of type T.
MaskProvider	getMask()	The MaskProvider used to create the binary mask.
void	setMask(MaskProvider mask)	The MaskProvider used to create the binary mask.

Methods inherited from class org.anchoranalysis.image.bean.provider.ChannelProvider

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

FromMaskBase

public FromMaskBase()

Method Details

get

public Channel 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.

createFromMask

protected abstract Channel createFromMask(Mask mask)
                                   throws ProvisionFailedException

Creates a Channel from the provided Mask.

Parameters:

mask - the Mask to create the channel from

Returns:

the created Channel

Throws:

ProvisionFailedException - if the channel creation fails

getMask

public MaskProvider getMask()

The MaskProvider used to create the binary mask.

setMask

public void setMask(MaskProvider mask)

The MaskProvider used to create the binary mask.