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

Class UnaryWithObjectsBase

Object

AnchorBean<ChannelProvider>

InitializableBean<ChannelProvider,ImageInitialization>

ImageBean<ChannelProvider>

BeanProviderAsStackBase<ChannelProvider,Channel>

ChannelProvider

ChannelProviderUnary

UnaryWithObjectsBase

All Implemented Interfaces:

Provider<Channel>, ProviderAsStack

Direct Known Subclasses:

IdentifyObjects, NormalizeDifferenceToMedian, NormalizeObjectIntensity, ScoreObjects

public abstract class UnaryWithObjectsBase
extends ChannelProviderUnary

An abstract base class for creating a channel from an existing channel and a collection of objects.

This class extends ChannelProviderUnary to provide a framework for creating channels based on an input channel and a collection of objects. Subclasses must implement the createFromChannel method.

Constructor Summary

Constructors

Constructor	Description
UnaryWithObjectsBase()

Method Summary

Modifier and Type	Method	Description
Channel	createFromChannel(Channel channel)	Creates a Channel given the entity provided by the delegate.
protected abstract Channel	createFromChannel(Channel channel, ObjectCollection objects)	Creates a new channel from an existing channel and a collection of objects.
ObjectCollectionProvider	getObjects()	The provider for the collection of objects to be used in channel creation.
void	setObjects(ObjectCollectionProvider objects)	The provider for the collection of objects to be used in channel creation.

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

get, getChannel, setChannel

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

UnaryWithObjectsBase

public UnaryWithObjectsBase()

Method Details

createFromChannel

public Channel createFromChannel(Channel channel)
                          throws ProvisionFailedException

Description copied from class: ChannelProviderUnary

Creates a Channel given the entity provided by the delegate.

Specified by:

createFromChannel in class ChannelProviderUnary

Parameters:

channel - the entity provided by the delegate.

Returns:

the created Channel that is returned by the provider.

Throws:

ProvisionFailedException - if the provider cannot complete successfully.

createFromChannel

protected abstract Channel createFromChannel(Channel channel,
 ObjectCollection objects)
                                      throws ProvisionFailedException

Creates a new channel from an existing channel and a collection of objects.

Parameters:

channel - the input Channel

objects - the ObjectCollection to be used in channel creation

Returns:

a new Channel created from the input channel and objects

Throws:

ProvisionFailedException - if the channel creation fails

getObjects

public ObjectCollectionProvider getObjects()

The provider for the collection of objects to be used in channel creation.

setObjects

public void setObjects(ObjectCollectionProvider objects)

The provider for the collection of objects to be used in channel creation.