edu.washington.biostr.sig.brainj3d.viewvolume.colors
Class AverageFunction

java.lang.Object
  edu.washington.biostr.sig.brainj3d.viewvolume.colors.BlendFunction
      edu.washington.biostr.sig.brainj3d.viewvolume.colors.SpecifiedWeightFunction
          edu.washington.biostr.sig.brainj3d.viewvolume.colors.AverageFunction

public class AverageFunction
extends SpecifiedWeightFunction

This blend function computes an equally weighted average between two colors.

Author:

Peter

Constructor Summary

AverageFunction()

Method Summary

boolean	allowDefaultConstructor() Returns true if instances of this blend function can be created using the default constructor.
AverageFunction	createNew(Object[] parameters) Creates a new instance of this BlendFunction using the given parameters.
Class[]	getDesiredParameters() Gets an array of types for the desired parameters for creating new instances of this BlendFunction.
Object[]	getDesiredParamterDefaultValues() Gets a new array of default values for each of the required parameters.
String	getName() Gets the name of this blend function.
String	getParametersTitle() Gets a string representing the title to use when displaying an input box for entering the desired parameters for creating a new instance of this BlendFunction.

Methods inherited from class edu.washington.biostr.sig.brainj3d.viewvolume.colors.SpecifiedWeightFunction

calculateColor, getDesiredParameterNames

Methods inherited from class edu.washington.biostr.sig.brainj3d.viewvolume.colors.BlendFunction

calculateColor, equals, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AverageFunction

public AverageFunction()

Method Detail

getName

public String getName()

Description copied from class: BlendFunction

Gets the name of this blend function.

Overrides:

getName in class SpecifiedWeightFunction

Returns:

the name of this blend function

allowDefaultConstructor

public boolean allowDefaultConstructor()

Description copied from class: BlendFunction

Returns true if instances of this blend function can be created using the default constructor.

Overrides:

allowDefaultConstructor in class SpecifiedWeightFunction

Returns:

createNew

public AverageFunction createNew(Object[] parameters)

Description copied from class: BlendFunction

Creates a new instance of this BlendFunction using the given parameters. The default implementation returns this BlendFunction if it allows the default constructor or null if it does not. Subclasses should override this method if they wish to support specification of initialization parameters.

Overrides:

createNew in class SpecifiedWeightFunction

Returns:

getDesiredParameters

public Class[] getDesiredParameters()

Description copied from class: BlendFunction

Gets an array of types for the desired parameters for creating new instances of this BlendFunction. Subclasses should override this method if they wish to support specification of initialization parameters.

Overrides:

getDesiredParameters in class SpecifiedWeightFunction

Returns:

getDesiredParamterDefaultValues

public Object[] getDesiredParamterDefaultValues()

Description copied from class: BlendFunction

Gets a new array of default values for each of the required parameters. Subclasses should override this method if they wish to support specification of initialization parameters.

Overrides:

getDesiredParamterDefaultValues in class SpecifiedWeightFunction

Returns:

getParametersTitle

public String getParametersTitle()

Description copied from class: BlendFunction

Gets a string representing the title to use when displaying an input box for entering the desired parameters for creating a new instance of this BlendFunction. Subclasses should override this method if they wish to support specification of initialization parameters.

Overrides:

getParametersTitle in class SpecifiedWeightFunction

Returns: