| java.lang.Object
 javax.media.jai.OperationDescriptorImpl
ca.forklabs.media.jai.operator.ImageFunction3DDescriptor
| ImageFunction3DDescriptor | | public class ImageFunction3DDescriptor extends OperationDescriptorImpl (Code) | | Class
ImageFunction3DDescriptor is an
OperationDescriptor describing the imagefunction operation for the collection mode.
This operation generates a collection of images based on a
ImageFunction3D .
The imagefunction operation takes two parameters, the image
function and the dimensions.
The default data type is
DataBuffer.TYPE_FLOAT . The other acceptable
data type is
DataBuffer.TYPE_DOUBLE and must be specified in a
SampleModel inside the
RenderingHints (key is
JAI.KEY_IMAGE_LAYOUT ).
Resource List
| Name | Value |
|---|
| GlobalName | ImageFunction3D |
| LocalName | ImageFunction3D |
| Vendor | ca.forklabs.media.jai.opimage |
| Description | Generates a collection of images from a functional description |
| DocURL | n/a |
| Version | $Version$ |
| Arg0Desct | The functional description |
| Arg0Desct | The width of the image |
| Arg0Desct | The height of the image |
| Arg0Desct | The depth of the image |
Parameter List
| Name | Class Type | Default Value |
|---|
| function |
ImageFunction3D | NO_PARAMETER_DEFAULT |
| width |
Integer | NO_PARAMETER_DEFAULT |
| height |
Integer | NO_PARAMETER_DEFAULT |
| depth |
Integer | NO_PARAMETER_DEFAULT |
author:
Daniel Léonard
version:
$Revision: 1.2 $ |
| Method Summary | |
| public static Collection<RenderedImage> | createCollection(ImageFunction3D function, int width, int height, int depth, RenderingHints hints)
Performs the imagefunction3d operation on with the given
functional description.
Parameters:
function - the functional description.
Parameters:
width - the width of the image.
Parameters:
height - the height of the image.
Parameters:
depth - the depth of the image.
Parameters:
hints - the rendering hints, may be null . | | public static ParameterBlockJAI | createParameterBlock(ImageFunction3D function, int width, int height, int depth)
Creates and fills a new parameter block for the collection mode.
Parameters:
function - the functional description.
Parameters:
width - the width of the image.
Parameters:
height - the height of the image.
Parameters:
depth - the depth of the image. | | protected static String | getArg0Description()
Gets the description for the first argument, the function. | | protected static String | getArg1Description()
Gets the description for the second argument, the width. | | protected static String | getArg2Description()
Gets the description for the third argument, the height. | | protected static String | getArg3Description()
Gets the description for the fourth argument, the depth. | | protected static String | getDescription()
Gets the description of this operation. |
| DEPTH_DEFAULT_VALUE | | final public static Object DEPTH_DEFAULT_VALUE(Code) | | The depth default value.
|
| DEPTH_PARAMETER_INDEX | | final public static int DEPTH_PARAMETER_INDEX(Code) | | The index in the parameter block of the depth parameter.
|
| DEPTH_PARAMETER_NAME | | final public static String DEPTH_PARAMETER_NAME(Code) | | The name of the depth parameter.
|
| DEPTH_VALID_VALUE | | final public static Object DEPTH_VALID_VALUE(Code) | | The depth default value.
|
| FUNCTION_DEFAULT_VALUE | | final public static Object FUNCTION_DEFAULT_VALUE(Code) | | The function default value.
|
| FUNCTION_PARAMETER_INDEX | | final public static int FUNCTION_PARAMETER_INDEX(Code) | | The index in the parameter block of the function parameter.
|
| FUNCTION_PARAMETER_NAME | | final public static String FUNCTION_PARAMETER_NAME(Code) | | The name of the function parameter.
|
| FUNCTION_VALID_VALUE | | final public static Object FUNCTION_VALID_VALUE(Code) | | The function default value.
|
| HEIGHT_DEFAULT_VALUE | | final public static Object HEIGHT_DEFAULT_VALUE(Code) | | The height default value.
|
| HEIGHT_PARAMETER_INDEX | | final public static int HEIGHT_PARAMETER_INDEX(Code) | | The index in the parameter block of the height parameter.
|
| HEIGHT_PARAMETER_NAME | | final public static String HEIGHT_PARAMETER_NAME(Code) | | The name of the height parameter.
|
| HEIGHT_VALID_VALUE | | final public static Object HEIGHT_VALID_VALUE(Code) | | The height default value.
|
| NAME | | final public static String NAME(Code) | | The name of this operator.
|
| WIDTH_DEFAULT_VALUE | | final public static Object WIDTH_DEFAULT_VALUE(Code) | | The width default value.
|
| WIDTH_PARAMETER_INDEX | | final public static int WIDTH_PARAMETER_INDEX(Code) | | The index in the parameter block of the width parameter.
|
| WIDTH_PARAMETER_NAME | | final public static String WIDTH_PARAMETER_NAME(Code) | | The name of the width parameter.
|
| WIDTH_VALID_VALUE | | final public static Object WIDTH_VALID_VALUE(Code) | | The width default value.
|
| ImageFunction3DDescriptor | | public ImageFunction3DDescriptor()(Code) | | Constructor.
|
| createCollection | | public static Collection<RenderedImage> createCollection(ImageFunction3D function, int width, int height, int depth, RenderingHints hints)(Code) | | Performs the imagefunction3d operation on with the given
functional description.
Parameters:
function - the functional description.
Parameters:
width - the width of the image.
Parameters:
height - the height of the image.
Parameters:
depth - the depth of the image.
Parameters:
hints - the rendering hints, may be null . the rendered result image. |
| createParameterBlock | | public static ParameterBlockJAI createParameterBlock(ImageFunction3D function, int width, int height, int depth)(Code) | | Creates and fills a new parameter block for the collection mode.
Parameters:
function - the functional description.
Parameters:
width - the width of the image.
Parameters:
height - the height of the image.
Parameters:
depth - the depth of the image. a new parameter block. |
| getArg0Description | | protected static String getArg0Description()(Code) | | Gets the description for the first argument, the function.
the description message. |
| getArg1Description | | protected static String getArg1Description()(Code) | | Gets the description for the second argument, the width.
the description message. |
| getArg2Description | | protected static String getArg2Description()(Code) | | Gets the description for the third argument, the height.
the description message. |
| getArg3Description | | protected static String getArg3Description()(Code) | | Gets the description for the fourth argument, the depth.
the description message. |
| getDescription | | protected static String getDescription()(Code) | | Gets the description of this operation.
the description message. |
| Methods inherited from javax.media.jai.OperationDescriptorImpl | public boolean arePropertiesSupported()(Code)(Java Doc)
protected static Class getDefaultSourceClass(String modeName)(Code)(Java Doc)
public Class getDestClass(String modeName)(Code)(Java Doc)
public Class getDestClass()(Code)(Java Doc)
public Object getInvalidRegion(String modeName, ParameterBlock oldParamBlock, RenderingHints oldHints, ParameterBlock newParamBlock, RenderingHints newHints, OperationNode node)(Code)(Java Doc)
public String getName()(Code)(Java Doc)
public int getNumParameters()(Code)(Java Doc)
public int getNumSources()(Code)(Java Doc)
public Class[] getParamClasses()(Code)(Java Doc)
public Object getParamDefaultValue(int index)(Code)(Java Doc)
public Object[] getParamDefaults()(Code)(Java Doc)
public Number getParamMaxValue(int index)(Code)(Java Doc)
public Number getParamMinValue(int index)(Code)(Java Doc)
public String[] getParamNames()(Code)(Java Doc)
public ParameterListDescriptor getParameterListDescriptor(String modeName)(Code)(Java Doc)
public PropertyGenerator[] getPropertyGenerators(String modeName)(Code)(Java Doc)
public PropertyGenerator[] getPropertyGenerators()(Code)(Java Doc)
public Class getRenderableDestClass()(Code)(Java Doc)
public Class[] getRenderableSourceClasses()(Code)(Java Doc)
public ResourceBundle getResourceBundle(Locale locale)(Code)(Java Doc)
public String[][] getResources(Locale locale)(Code)(Java Doc)
public Class[] getSourceClasses(String modeName)(Code)(Java Doc)
public Class[] getSourceClasses()(Code)(Java Doc)
public String[] getSourceNames()(Code)(Java Doc)
public String[] getSupportedModes()(Code)(Java Doc)
public boolean isImmediate()(Code)(Java Doc)
public boolean isModeSupported(String modeName)(Code)(Java Doc)
public boolean isRenderableSupported()(Code)(Java Doc)
public boolean isRenderedSupported()(Code)(Java Doc)
protected static Class[][] makeDefaultSourceClassList(String[] supportedModes, int numSources)(Code)(Java Doc)
public boolean validateArguments(String modeName, ParameterBlock args, StringBuffer msg)(Code)(Java Doc)
public boolean validateArguments(ParameterBlock args, StringBuffer msg)(Code)(Java Doc)
protected boolean validateParameters(String modeName, ParameterBlock args, StringBuffer msg)(Code)(Java Doc)
protected boolean validateParameters(ParameterBlock args, StringBuffer msg)(Code)(Java Doc)
public boolean validateRenderableArguments(ParameterBlock args, StringBuffer msg)(Code)(Java Doc)
protected boolean validateRenderableSources(ParameterBlock args, StringBuffer msg)(Code)(Java Doc)
protected boolean validateSources(String modeName, ParameterBlock args, StringBuffer msg)(Code)(Java Doc)
protected boolean validateSources(ParameterBlock args, StringBuffer msg)(Code)(Java Doc)
|
|
|