Added in API level 21

RggbChannelVector

class RggbChannelVector
kotlin.Any
   ↳ android.hardware.camera2.params.RggbChannelVector

Immutable class to store a 4-element vector of floats indexable by a bayer RAW 2x2 pixel block.

Summary

Constants
static Int

Blue color channel in a bayer Raw pattern.
static Int

The number of color channels in this vector.
static Int

Green color channel in a bayer Raw pattern used by the even rows.
static Int

Green color channel in a bayer Raw pattern used by the odd rows.
static Int

Red color channel in a bayer Raw pattern.
Public constructors
RggbChannelVector(red: Float, greenEven: Float, greenOdd: Float, blue: Float)

Create a new RggbChannelVector from an RGGB 2x2 pixel.
Public methods
Unit
copyTo(destination: FloatArray!, offset: Int)

Copy the vector into the destination in the order [R, Geven, Godd, B].
Boolean
equals(other: Any?)

Check if this RggbChannelVector is equal to another RggbChannelVector.
Float

Get the blue component.
Float
getComponent(colorChannel: Int)

Get the component by the color channel index.
Float

Get the green (even rows) component.
Float

Get the green (odd rows) component.
Float

Get the red component.
Int

Returns a hash code value for the object.
String

Return the RggbChannelVector as a string representation.

Constants

BLUE

Added in API level 21
static val BLUE: Int

Blue color channel in a bayer Raw pattern.

Value: 3

COUNT

Added in API level 21
static val COUNT: Int

The number of color channels in this vector.

Value: 4

GREEN_EVEN

Added in API level 21
static val GREEN_EVEN: Int

Green color channel in a bayer Raw pattern used by the even rows.

Value: 1

GREEN_ODD

Added in API level 21
static val GREEN_ODD: Int

Green color channel in a bayer Raw pattern used by the odd rows.

Value: 2

RED

Added in API level 21
static val RED: Int

Red color channel in a bayer Raw pattern.

Value: 0

Public constructors

RggbChannelVector

Added in API level 21
RggbChannelVector(
    red: Float, 
    greenEven: Float, 
    greenOdd: Float, 
    blue: Float)

Create a new RggbChannelVector from an RGGB 2x2 pixel.

All pixel values are considered normalized within [0.0f, 1.0f] (i.e. 1.0f could be linearized to 255 if converting to a non-floating point pixel representation).

All arguments must be finite; NaN and infinity is not allowed.

Parameters
red Float: red pixel
greenEven Float: green pixel (even row)
greenOdd Float: green pixel (odd row)
blue Float: blue pixel
Exceptions
java.lang.IllegalArgumentException if any of the arguments were not finite

Public methods

copyTo

Added in API level 21
fun copyTo(
    destination: FloatArray!, 
    offset: Int
): Unit

Copy the vector into the destination in the order [R, Geven, Godd, B].

Parameters
destination FloatArray!: an array big enough to hold at least {@value #COUNT} elements after the offset
offset Int: a non-negative offset into the array
Exceptions
java.lang.NullPointerException If destination was null
java.lang.ArrayIndexOutOfBoundsException If there's not enough room to write the elements at the specified destination and offset.

equals

Added in API level 21
fun equals(other: Any?): Boolean

Check if this RggbChannelVector is equal to another RggbChannelVector.

Two vectors are only equal if and only if each of the respective elements is equal.

Parameters
obj the reference object with which to compare.
Return
Boolean true if the objects were equal, false otherwise

getBlue

Added in API level 21
fun getBlue(): Float

Get the blue component.

Return
Float a floating point value (guaranteed to be finite)

getComponent

Added in API level 21
fun getComponent(colorChannel: Int): Float

Get the component by the color channel index.

colorChannel must be one of RED, GREEN_EVEN, GREEN_ODD, BLUE.

Parameters
colorChannel Int: greater or equal to 0 and less than COUNT
Return
Float a floating point value (guaranteed to be finite)
Exceptions
java.lang.IllegalArgumentException if colorChannel was out of range

getGreenEven

Added in API level 21
fun getGreenEven(): Float

Get the green (even rows) component.

Return
Float a floating point value (guaranteed to be finite)

getGreenOdd

Added in API level 21
fun getGreenOdd(): Float

Get the green (odd rows) component.

Return
Float a floating point value (guaranteed to be finite)

getRed

Added in API level 21
fun getRed(): Float

Get the red component.

Return
Float a floating point value (guaranteed to be finite)

hashCode

Added in API level 21
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Return
Int a hash code value for this object.

toString

Added in API level 21
fun toString(): String

Return the RggbChannelVector as a string representation.

"RggbChannelVector{R:%f, G_even:%f, G_odd:%f, B:%f}", where each %f respectively represents one of the the four color channels.

Return
String string representation of RggbChannelVector