org.anchoranalysis.image.core.channel.convert.attached

Interface ChannelConverterAttached<S,T>

Type Parameters:

S - type of object to which the channel-convert is attached.

T - buffer-type the voxels will be converted to.

All Known Implementing Classes:

IntensityRange, MaxIntensity, MaxIntensityFromHistogram, QuantileIntensity, QuantileIntensityFromHistogram, UpperLowerQuantileIntensity, UpperLowerQuantileIntensityFromHistogram

public interface ChannelConverterAttached<S,T>

A channel-converter that has been permanently associated with a particular object.

This object can provide necessary parameters (e.g. ranges of voxel intensities) for the conversion.

Author:

Owen Feehan

Method Summary

Modifier and Type	Method and Description
void	attachObject(S object) Associate the convert with a particular object.
Channel	convert(Channel channel, ConversionPolicy changeExisting) Converts the voxel-type in a Channel.
VoxelsConverter<T>	getVoxelsConverter() Converts voxels to have type voxel-type T.

Method Detail

attachObject

void attachObject(S object)
           throws OperationFailedException

Associate the convert with a particular object.

Parameters:

object - the object to associate the converter with.

Throws:

OperationFailedException - if the association cannot be completed successfully.

convert

Channel convert(Channel channel,
                ConversionPolicy changeExisting)

Converts the voxel-type in a Channel.

Parameters:

channel - the channel whose voxels will be converted.

changeExisting - if ture, the are voxels in-place, preserving the existing Channel object. Otherwise a new Channel is created.

Returns:

the existing Channel or newly created one, as per above.

getVoxelsConverter

VoxelsConverter<T> getVoxelsConverter()

Converts voxels to have type voxel-type T.

Returns:

the converter.