| ca.forklabs.media.jai.CollectionDescriptor
 ca.forklabs.media.jai.operator.SpectralHomomorphicDescriptor
| SpectralHomomorphicDescriptor | | public class SpectralHomomorphicDescriptor extends CollectionDescriptor (Code) | | Class
SpectralHomomorphicDescriptor is an
OperationDescriptor describing the spectralhomomorphic operation. This composite
operation consists of these eight steps :
format -> addconst(+1) -> log -> fft -> filter -> ifft -> exp -> subtractconst(+1)
The SpectralHomomorphic operation takes two parameters, the filter
and the data type for the format operation :
- filter
- This argument will provide the filter image to multiply to the Fourier
transform.
- data type
- This argument is the type for the format operation. Data format can be
found in enum
FormatDataType . The default value is
FormatDataType.FLOAT .
Here is a description of each step :
- format
- The format step change the type of the image pixel. Its behaviour can
be controlled with the data type parameter.
- addconst(+1)
- This step adds one to each pixel so that when the log step is applied,
there are no zero-valued pixels.
- log
- This step calculates the logarithm value of each pixel.
- fft
- This step calculates the Fourier Transform, using no scaling.
- filter
- The filter image will be generated and multiplied to the Fourier
transform.
- ifft
- This step calculates the Inverse Fourier Transform, using the
dimension scaling.
- exp
- This step calculates the exponential value of each pixel, it is the
reverse of the log operation
- subtractconst(+1)
- This step subtracts one from each pixel value, it is the reverse of
the addconst(+1) step.
Resource List
| Name | Value |
|---|
| GlobalName | SpectralHomomorphic |
| LocalName | SpectralHomomorphic |
| Vendor | ca.umontreal.iro.image.arcticice |
| Description | Spectral Homomorphic Filter |
| DocURL | n/a |
| Version | $Version$ |
| Arg0Desct | The spectral filter |
| Arg1Desct | The data type for the format operation |
Parameter List for the rendered and renderable modes
| Name | Class Type | Default Value |
|---|
| filter | SpectralFilter2D | NO_PARAMETER_DEFAULT |
| type | FormatDataType | FormatDataType.FLOAT |
Parameter List for the collection mode
| Name | Class Type | Default Value |
|---|
| filter | SpectralFilter3D | NO_PARAMETER_DEFAULT |
| type | FormatDataType | FormatDataType.FLOAT |
author:
Daniel Léonard
version:
$Revision: 1.2 $ |
| Method Summary | |
| public static RenderedOp | create(RenderedImage source, SpectralFilter2D filter, FormatDataType type, RenderingHints hints)
Performs the spatial homomorphic filter operation on a rendered image.
Parameters:
source - the image to enhance.
Parameters:
filter - the filter.
Parameters:
type - the data type for the initial format.
Parameters:
hints - the rendering hints, may be null . | | public static CollectionImage | createCollection(CollectionImage source, SpectralFilter3D filter, FormatDataType type, RenderingHints hints)
Performs the spatial homomorphic filter operation on a rendered image.
Parameters:
source - the image to enhance.
Parameters:
filter - the filter.
Parameters:
type - the data type for the initial format.
Parameters:
hints - the rendering hints, may be null . | | public static ParameterBlockJAI | createParameterBlock(String mode, Object source, SpectralFilter2D filter, FormatDataType type)
Creates and fills a new parameter block.
Parameters:
mode - the rendering mode (usually rendered or renderable).
Parameters:
source - the source image.
Parameters:
filter - the filter
Parameters:
type - the data type for the format operation. | | public static ParameterBlockJAI | createParameterBlock(String mode, Object source, SpectralFilter3D filter, FormatDataType type)
Creates and fills a new parameter block.
Parameters:
mode - the rendering mode (usually collection).
Parameters:
source - the source image.
Parameters:
filter - the filter
Parameters:
type - the data type for the format operation. | | public static ParameterBlockJAI | createParameterBlock(RenderedImage source, SpectralFilter2D filter, FormatDataType type)
Creates and fills a new parameter block for the rendered mode.
Parameters:
source - the source image.
Parameters:
filter - the filter.
Parameters:
type - the data type for the format operation. | | public static ParameterBlockJAI | createParameterBlock(RenderableImage source, SpectralFilter2D filter, FormatDataType type)
Creates and fills a new parameter block for the renderable mode.
Parameters:
source - the source image.
Parameters:
filter - the filter.
Parameters:
type - the data type for the format operation. | | public static ParameterBlockJAI | createParameterBlock(CollectionImage source, SpectralFilter3D filter, FormatDataType type)
Creates and fills a new parameter block for the collection mode.
Parameters:
source - the source image.
Parameters:
filter - the filter.
Parameters:
type - the data type for the format operation. | | public static RenderableOp | createRenderable(RenderableImage source, SpectralFilter2D filter, FormatDataType type, RenderingHints hints)
Performs the spatial homomorphic filter operation on a renderable image.
Parameters:
source - the image to enhance.
Parameters:
filter - the filter.
Parameters:
type - the data type for the initial format.
Parameters:
hints - the rendering hints, may be null . | | protected static String | getArg0Description()
Gets the description for the first argument, the spectral filter. | | protected static String | getArg1Description()
Gets the description for the second argument, the format data type. | | protected static String | getDescription()
Gets the description of this operation. |
| FILTER_PARAMETER_INDEX | | final public static int FILTER_PARAMETER_INDEX(Code) | | The index in the parameter block of the filter parameter.
|
| FILTER_PARAMETER_NAME | | final public static String FILTER_PARAMETER_NAME(Code) | | The name of the filter parameter.
|
| NAME | | final public static String NAME(Code) | | The name of this operator.
|
| TYPE_PARAMETER_INDEX | | final public static int TYPE_PARAMETER_INDEX(Code) | | The index in the parameter block of the data type parameter.
|
| TYPE_PARAMETER_NAME | | final public static String TYPE_PARAMETER_NAME(Code) | | The name of the initial format type parameter.
|
| SpectralHomomorphicDescriptor | | public SpectralHomomorphicDescriptor()(Code) | | Constructor.
|
| create | | public static RenderedOp create(RenderedImage source, SpectralFilter2D filter, FormatDataType type, RenderingHints hints)(Code) | | Performs the spatial homomorphic filter operation on a rendered image.
Parameters:
source - the image to enhance.
Parameters:
filter - the filter.
Parameters:
type - the data type for the initial format.
Parameters:
hints - the rendering hints, may be null . the rendered result image. |
| createCollection | | public static CollectionImage createCollection(CollectionImage source, SpectralFilter3D filter, FormatDataType type, RenderingHints hints)(Code) | | Performs the spatial homomorphic filter operation on a rendered image.
Parameters:
source - the image to enhance.
Parameters:
filter - the filter.
Parameters:
type - the data type for the initial format.
Parameters:
hints - the rendering hints, may be null . the rendered result image. |
| createParameterBlock | | public static ParameterBlockJAI createParameterBlock(String mode, Object source, SpectralFilter2D filter, FormatDataType type)(Code) | | Creates and fills a new parameter block.
Parameters:
mode - the rendering mode (usually rendered or renderable).
Parameters:
source - the source image.
Parameters:
filter - the filter
Parameters:
type - the data type for the format operation. a new parameter block. |
| createParameterBlock | | public static ParameterBlockJAI createParameterBlock(String mode, Object source, SpectralFilter3D filter, FormatDataType type)(Code) | | Creates and fills a new parameter block.
Parameters:
mode - the rendering mode (usually collection).
Parameters:
source - the source image.
Parameters:
filter - the filter
Parameters:
type - the data type for the format operation. a new parameter block. |
| createParameterBlock | | public static ParameterBlockJAI createParameterBlock(RenderedImage source, SpectralFilter2D filter, FormatDataType type)(Code) | | Creates and fills a new parameter block for the rendered mode.
Parameters:
source - the source image.
Parameters:
filter - the filter.
Parameters:
type - the data type for the format operation. a new parameter block. |
| createParameterBlock | | public static ParameterBlockJAI createParameterBlock(RenderableImage source, SpectralFilter2D filter, FormatDataType type)(Code) | | Creates and fills a new parameter block for the renderable mode.
Parameters:
source - the source image.
Parameters:
filter - the filter.
Parameters:
type - the data type for the format operation. a new parameter block. |
| createParameterBlock | | public static ParameterBlockJAI createParameterBlock(CollectionImage source, SpectralFilter3D filter, FormatDataType type)(Code) | | Creates and fills a new parameter block for the collection mode.
Parameters:
source - the source image.
Parameters:
filter - the filter.
Parameters:
type - the data type for the format operation. a new parameter block. |
| createRenderable | | public static RenderableOp createRenderable(RenderableImage source, SpectralFilter2D filter, FormatDataType type, RenderingHints hints)(Code) | | Performs the spatial homomorphic filter operation on a renderable image.
Parameters:
source - the image to enhance.
Parameters:
filter - the filter.
Parameters:
type - the data type for the initial format.
Parameters:
hints - the rendering hints, may be null . the rendered result image. |
| getArg0Description | | protected static String getArg0Description()(Code) | | Gets the description for the first argument, the spectral filter.
the description message. |
| getArg1Description | | protected static String getArg1Description()(Code) | | Gets the description for the second argument, the format data type.
the description message. |
| getDescription | | protected static String getDescription()(Code) | | Gets the description of this operation.
the description message. |
|
|