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

Class AssignFromDictionary

Object

AnchorBean<ChannelProvider>

InitializableBean<ChannelProvider,ImageInitialization>

ImageBean<ChannelProvider>

BeanProviderAsStackBase<ChannelProvider,Channel>

ChannelProvider

ChannelProviderUnary

AssignFromDictionary

All Implemented Interfaces:

Provider<Channel>, ProviderAsStack

public class AssignFromDictionary
extends ChannelProviderUnary

Assigns a value from a dictionary to all voxels in a channel.

This class extends ChannelProviderUnary to create a new channel by assigning a single value, retrieved from a dictionary, to all voxels in the input channel.

Constructor Summary

Constructors

Constructor	Description
AssignFromDictionary()

Method Summary

Modifier and Type	Method	Description
Channel	createFromChannel(Channel channel)	Creates a Channel given the entity provided by the delegate.
DictionaryProvider	getDictionary()	The dictionary from which an assignment will occur.
String	getKey()	The key of the value in the dictionary that will be assigned.
void	setDictionary(DictionaryProvider dictionary)	The dictionary from which an assignment will occur.
void	setKey(String key)	The key of the value in the dictionary that will be assigned.

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

AssignFromDictionary

public AssignFromDictionary()

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.

getDictionary

public DictionaryProvider getDictionary()

The dictionary from which an assignment will occur.

setDictionary

public void setDictionary(DictionaryProvider dictionary)

The dictionary from which an assignment will occur.

getKey

public String getKey()

The key of the value in the dictionary that will be assigned.

setKey

public void setKey(String key)

The key of the value in the dictionary that will be assigned.