Package org.anchoranalysis.plugin.image.feature.bean.object.single.surface

Class SurfaceNumberVoxelsBase

Object

AnchorBean<Feature<FeatureInputSingleObject>>

InitializableBean<Feature<FeatureInputSingleObject>,FeatureInitialization>

Feature<FeatureInputSingleObject>

FeatureSingleObject

SurfaceNumberVoxelsBase

Direct Known Subclasses:

SurfaceNumberVoxelFaces, SurfaceNumberVoxels

public abstract class SurfaceNumberVoxelsBase
extends FeatureSingleObject

A base class for features that calculate the number of voxels on the surface of an object.

Constructor Summary

Constructors

Constructor	Description
SurfaceNumberVoxelsBase()

Method Summary

Modifier and Type	Method	Description
double	calculate(FeatureCalculationInput<FeatureInputSingleObject> input)	Calculates a value for some input.
protected abstract CalculationPart<Integer,FeatureInputSingleObject>	createParameters(boolean mip, boolean suppress3d)	Creates the calculation parameters for the surface voxel count.
boolean	isMip()	If true, calculates the surface on a maximum intensity projection rather than the 3D object.
boolean	isSuppress3D()	If true, suppresses 3D calculations and treats the object as 2D.
void	setMip(boolean mip)	If true, calculates the surface on a maximum intensity projection rather than the 3D object.
void	setSuppress3D(boolean suppress3D)	If true, suppresses 3D calculations and treats the object as 2D.

Methods inherited from class org.anchoranalysis.image.feature.bean.object.single.FeatureSingleObject

inputType

Methods inherited from class org.anchoranalysis.feature.bean.Feature

assignTo, beforeCalc, calculateCheckInitialized, castAs, createListChildFeatures, describeBean, describeParameters, descriptionLong, duplicateChangeName, getCustomName, getFriendlyName, onInitialization, setCustomName, toString

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

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

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

SurfaceNumberVoxelsBase

public SurfaceNumberVoxelsBase()

Method Details

calculate

public double calculate(FeatureCalculationInput<FeatureInputSingleObject> input)
                 throws FeatureCalculationException

Description copied from class: Feature

Calculates a value for some input.

Specified by:

calculate in class Feature<FeatureInputSingleObject>

Parameters:

input - the input to the calculation.

Returns:

the result of the calculation.

Throws:

FeatureCalculationException - if the calculation cannot successfully complete.

createParameters

protected abstract CalculationPart<Integer,FeatureInputSingleObject> createParameters(boolean mip,
 boolean suppress3d)

Creates the calculation parameters for the surface voxel count.

Parameters:

mip - whether to use maximum intensity projection

suppress3d - whether to suppress 3D calculations

Returns:

a CalculationPart for calculating the number of surface voxels

isMip

public boolean isMip()

If true, calculates the surface on a maximum intensity projection rather than the 3D object.

setMip

public void setMip(boolean mip)

If true, calculates the surface on a maximum intensity projection rather than the 3D object.

isSuppress3D

public boolean isSuppress3D()

If true, suppresses 3D calculations and treats the object as 2D.

setSuppress3D

public void setSuppress3D(boolean suppress3D)

If true, suppresses 3D calculations and treats the object as 2D.