HSB (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- script.imglib.color.fn.ColorFunction
- - script.imglib.color.HSB

All Implemented Interfaces:

IFunction, ImageComputation<RGBALegacyType>
```
public final class HSB
extends ColorFunction
```
TODO

Nested Class Summary
- Nested classes/interfaces inherited from class script.imglib.color.fn.ColorFunction
  ColorFunction.Channel

Field Summary
- Fields inherited from class script.imglib.color.fn.ColorFunction
  empty

Constructor Summary

Constructors
Constructor and Description
`HSB(IFunction hue, IFunction saturation, IFunction brightness)`
`HSB(IFunction fn, int channel)` Creates an HSB with only the given channel filled, from 1 to 4, where HSB is really ARGB and thus A=4, R=3, G=2, B=1.
`HSB(Image<? extends RealType<?>> img)` Interpret the @param img as an HSB image.
`HSB(Object hue)` Accepts only `Image`, `Number`, `IFunction` instances or null as arguments.
`HSB(Object ob, int channel)` Creates an HSB with only the given channel filled, from 1 to 4, where HSB is really ARGB and thus A=4, R=3, G=2, B=1.
`HSB(Object hue, Object saturation)` Accepts only `Image`, `Number`, `IFunction` instances or null as arguments.
`HSB(Object hue, Object saturation, Object brightness)` Accepts only `Image`, `Number`, `IFunction` instances or null as arguments.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IFunction`	`duplicate()`
`double`	`eval()` Returns each HSB value packed in an `int` that is casted to `double`.
`void`	`findCursors(Collection<Cursor<?>> cursors)` Put any cursors in use by this function (and any nested functions) in @param cursors.

Methods inherited from class script.imglib.color.fn.ColorFunction
asImage, asImage, wrap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HSB
```
public HSB(IFunction hue,
           IFunction saturation,
           IFunction brightness)
```
  - HSB
```
public HSB(Image<? extends RealType<?>> img)
```
    Interpret the @param img as an HSB image.
  - HSB
```
public HSB(Object hue,
           Object saturation,
           Object brightness)
    throws Exception
```
    Accepts only Image, Number, IFunction instances or null as arguments.
    
    Throws:
    
    Exception
  - HSB
```
public HSB(Object hue,
           Object saturation)
    throws Exception
```
    Accepts only Image, Number, IFunction instances or null as arguments.
    
    Throws:
    
    Exception
  - HSB
```
public HSB(Object hue)
    throws Exception
```
    Accepts only Image, Number, IFunction instances or null as arguments.
    
    Throws:
    
    Exception
  - HSB
```
public HSB(IFunction fn,
           int channel)
    throws IllegalArgumentException
```
    Creates an HSB with only the given channel filled, from 1 to 4, where HSB is really ARGB and thus A=4, R=3, G=2, B=1.
    
    Throws:
    
    Exception - If the channel < 1 or > 4.
    
    IllegalArgumentException
  - HSB
```
public HSB(Object ob,
           int channel)
    throws Exception,
           IllegalArgumentException
```
    Creates an HSB with only the given channel filled, from 1 to 4, where HSB is really ARGB and thus A=4, R=3, G=2, B=1.
    
    Parameters:
    
    ob - can be an instance of Image, Number, IFunction, or null.
    
    Throws:
    
    Exception - If the channel < 1 or > 4.
    
    IllegalArgumentException
- Method Detail
  - duplicate
```
public final IFunction duplicate()
                          throws Exception
```
    Throws:
    
    Exception
  - eval
```
public final double eval()
```
    Returns each HSB value packed in an int that is casted to double.
  - findCursors
```
public final void findCursors(Collection<Cursor<?>> cursors)
```
    Description copied from interface: IFunction
    
    Put any cursors in use by this function (and any nested functions) in @param cursors.

Class HSB

Nested Class Summary

Nested classes/interfaces inherited from class script.imglib.color.fn.ColorFunction

Field Summary

Fields inherited from class script.imglib.color.fn.ColorFunction

Constructor Summary

Method Summary

Methods inherited from class script.imglib.color.fn.ColorFunction

Methods inherited from class java.lang.Object

Constructor Detail

HSB

HSB

HSB

HSB

HSB

HSB

HSB

Method Detail

duplicate

eval

findCursors