ComponentDisplaySettings

```
public interface ComponentDisplaySettings
```
Certain cameras (such as RGB cameras) can produce images where each pixel has multiple components. This interface determines how these components should be displayed.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface ComponentDisplaySettings.Builder
Interface for ComponentDisplaySettings Builder.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`ComponentDisplaySettings.Builder` Interface for ComponentDisplaySettings Builder.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static ComponentDisplaySettings.Builder`	`builder()`
`ComponentDisplaySettings.Builder`	`copyBuilder()`
`default double`	`getEffectiveScalingMaximum()` Scaling maximum as a pixel value, whichever range is in effect.
`default double`	`getEffectiveScalingMinimum()` Scaling minimum as a pixel value, whichever range is in effect.
`default double`	`getFloatScalingMaximum()` Returns the scaling maximum as an actual pixel value, for floating point images.
`default double`	`getFloatScalingMinimum()` Returns the scaling minimum as an actual pixel value, for floating point images.
`double`	`getScalingGamma()`
`long`	`getScalingMaximum()`
`long`	`getScalingMinimum()`
`default boolean`	`hasFloatScaling()` Returns whether a floating point scaling range has been set.

- Method Detail
  - getScalingMinimum
```
long getScalingMinimum()
```
  - getScalingMaximum
```
long getScalingMaximum()
```
  - getFloatScalingMinimum
```
default double getFloatScalingMinimum()
```
    Returns the scaling minimum as an actual pixel value, for floating point images.
    The default implementation reports no float scaling, so that implementations written before float scaling existed keep compiling.
    
    Returns:
    
    pixel value, or Double.NaN if no float scaling has been set
    
    See Also:
    
    hasFloatScaling()
  - getFloatScalingMaximum
```
default double getFloatScalingMaximum()
```
    Returns the scaling maximum as an actual pixel value, for floating point images.
    
    Returns:
    
    pixel value, or Double.NaN if no float scaling has been set
    
    See Also:
    
    hasFloatScaling()
  - hasFloatScaling
```
default boolean hasFloatScaling()
```
    Returns whether a floating point scaling range has been set.
    When false, callers displaying float images should fall back to deriving a range from the image statistics.
    
    Returns:
    
    true if both bounds are set and the maximum is strictly above the minimum; an empty or inverted range counts as unset, since it cannot be displayed
  - getEffectiveScalingMinimum
```
default double getEffectiveScalingMinimum()
```
    Scaling minimum as a pixel value, whichever range is in effect.
    Returns the float range when one is set, and otherwise the long-valued range widened to a double. Use this rather than getScalingMinimum() anywhere the value feeds a renderer or a file, so that float images are handled correctly without every caller having to branch on hasFloatScaling().
    
    Returns:
    
    the scaling minimum
  - getEffectiveScalingMaximum
```
default double getEffectiveScalingMaximum()
```
    Scaling maximum as a pixel value, whichever range is in effect.
    
    Returns:
    
    the scaling maximum
    
    See Also:
    
    getEffectiveScalingMinimum()
  - getScalingGamma
```
double getScalingGamma()
```
  - copyBuilder
```
ComponentDisplaySettings.Builder copyBuilder()
```
  - builder
```
static ComponentDisplaySettings.Builder builder()
```

Interface ComponentDisplaySettings

Nested Class Summary

Method Summary

Method Detail

getScalingMinimum

getScalingMaximum

getFloatScalingMinimum

getFloatScalingMaximum

hasFloatScaling

getEffectiveScalingMinimum

getEffectiveScalingMaximum

getScalingGamma

copyBuilder

builder