| ca.forklabs.media.jai.CollectionDescriptor
 ca.forklabs.media.jai.operator.PeriodicShift3DDescriptor
| PeriodicShift3DDescriptor | | public class PeriodicShift3DDescriptor extends CollectionDescriptor (Code) | | Class
PeriodicShift3DDescriptor is an
OperationDescriptor describing the periodicshift operation. This operation is an
extension of JAI operator periodicshift.
The periodicshift operation takes three parameters: the shift in
x (the width of the image), the shift in y (the height of
the image) and the shift in z (the depth of the image).
It is assumed that all the images in the collection are of the same size,
otherwise surprising results may occurs especially with default values.
Resource List
| Name | Value |
|---|
| GlobalName | PeriodicShift3D |
| LocalName | PeriodicShift3D |
| Vendor | ca.forklabs.media.jai.opimage |
| Description | Periodic shift on a 3D image |
| DocURL | n/a |
| Version | $Version$ |
| Arg0Desct | The displacement in the X direction (optional) |
| Arg1Desct | The displacement in the Y direction (optional) |
| Arg2Desct | The displacement in the Z direction (optional) |
Parameter List
| Name | Class Type | Default Value |
|---|
| shiftX | Integer | sourceWidth/2 |
| shiftY | Integer | sourceHeight/2 |
| shiftZ | Integer | sourceDepth/2 |
author:
Daniel Léonard
version:
$Revision: 1.4 $ |
| Method Summary | |
| public static Collection<RenderedImage> | createCollection(Collection<RenderedImage> sources, int shift_x, int shift_y, int shift_z, RenderingHints hints)
Performs the operation on a collection of rendered image.
Parameters:
sources - the source images.
Parameters:
shift_x - the displacement in x.
Parameters:
shift_y - the displacement in y.
Parameters:
shift_z - the displacement in z.
Parameters:
hints - the rendering hints, may be null . | | protected static ParameterBlockJAI | createParameterBlock(String mode, Object source, int shift_x, int shift_y, int shift_z)
Creates and fills a new parameter block.
Parameters:
mode - the rendering mode.
Parameters:
source - the source image.
Parameters:
shift_x - the displacement in x.
Parameters:
shift_y - the displacement in y.
Parameters:
shift_z - the displacement in z. | | public static Collection<RenderableImage> | createRenderableCollection(Collection<RenderableImage> sources, int shift_x, int shift_y, int shift_z, RenderingHints hints)
Performs the operation on a collection of renderable image.
Parameters:
sources - the source images.
Parameters:
shift_x - the displacement in x.
Parameters:
shift_y - the displacement in y.
Parameters:
shift_z - the displacement in z.
Parameters:
hints - the rendering hints, may be null . | | protected static String | getArg0Description()
Gets the description for the first argument, the displacement in
x. | | protected static String | getArg1Description()
Gets the description for the second argument, the displacement in
y. | | protected static String | getArg2Description()
Gets the description for the third argument, the displacement in
z. | | protected static String | getDescription()
Gets the description of this operation. | | public boolean | validateParameters(String mode, ParameterBlock pb, StringBuffer sb)
Adds the shiftZ parameter if it is missing then makes sure that
all the image in the collection are of the same type.
Parameters:
mode - the rendering mode.
Parameters:
pb - the parameter block.
Parameters:
sb - the error message buffer. |
| NAME | | final public static String NAME(Code) | | The name of this operator.
|
| SHIFT_X_PARAMETER_INDEX | | final public static int SHIFT_X_PARAMETER_INDEX(Code) | | The index in the parameter block of the shifX parameter.
|
| SHIFT_X_PARAMETER_NAME | | final public static String SHIFT_X_PARAMETER_NAME(Code) | | The name of the shiftX parameter.
|
| SHIFT_Y_PARAMETER_INDEX | | final public static int SHIFT_Y_PARAMETER_INDEX(Code) | | The index in the parameter block of the shifY parameter.
|
| SHIFT_Y_PARAMETER_NAME | | final public static String SHIFT_Y_PARAMETER_NAME(Code) | | The name of the shiftY parameter.
|
| SHIFT_Z_PARAMETER_INDEX | | final public static int SHIFT_Z_PARAMETER_INDEX(Code) | | The index in the parameter block of the shifZ parameter.
|
| SHIFT_Z_PARAMETER_NAME | | final public static String SHIFT_Z_PARAMETER_NAME(Code) | | The name of the shiftZ parameter.
|
| PeriodicShift3DDescriptor | | public PeriodicShift3DDescriptor()(Code) | | Constructor.
|
| createCollection | | public static Collection<RenderedImage> createCollection(Collection<RenderedImage> sources, int shift_x, int shift_y, int shift_z, RenderingHints hints)(Code) | | Performs the operation on a collection of rendered image.
Parameters:
sources - the source images.
Parameters:
shift_x - the displacement in x.
Parameters:
shift_y - the displacement in y.
Parameters:
shift_z - the displacement in z.
Parameters:
hints - the rendering hints, may be null . the resulting images. |
| createParameterBlock | | protected static ParameterBlockJAI createParameterBlock(String mode, Object source, int shift_x, int shift_y, int shift_z)(Code) | | Creates and fills a new parameter block.
Parameters:
mode - the rendering mode.
Parameters:
source - the source image.
Parameters:
shift_x - the displacement in x.
Parameters:
shift_y - the displacement in y.
Parameters:
shift_z - the displacement in z. a new parameter block. |
| createRenderableCollection | | public static Collection<RenderableImage> createRenderableCollection(Collection<RenderableImage> sources, int shift_x, int shift_y, int shift_z, RenderingHints hints)(Code) | | Performs the operation on a collection of renderable image.
Parameters:
sources - the source images.
Parameters:
shift_x - the displacement in x.
Parameters:
shift_y - the displacement in y.
Parameters:
shift_z - the displacement in z.
Parameters:
hints - the rendering hints, may be null . the resulting images. |
| getArg0Description | | protected static String getArg0Description()(Code) | | Gets the description for the first argument, the displacement in
x.
the description message. |
| getArg1Description | | protected static String getArg1Description()(Code) | | Gets the description for the second argument, the displacement in
y.
the description message. |
| getArg2Description | | protected static String getArg2Description()(Code) | | Gets the description for the third argument, the displacement in
z.
the description message. |
| getDescription | | protected static String getDescription()(Code) | | Gets the description of this operation.
the description message. |
| validateParameters | | public boolean validateParameters(String mode, ParameterBlock pb, StringBuffer sb)(Code) | | Adds the shiftZ parameter if it is missing then makes sure that
all the image in the collection are of the same type.
Parameters:
mode - the rendering mode.
Parameters:
pb - the parameter block.
Parameters:
sb - the error message buffer. true if all is OK, false otherwise. |
|
|