LensShadingMap
public
final
class
LensShadingMap
extends Object
java.lang.Object | |
↳ | android.hardware.camera2.params.LensShadingMap |
Immutable class for describing a 4 x N x M
lens shading map of floats.
Summary
Constants | |
---|---|
float |
MINIMUM_GAIN_FACTOR
The smallest gain factor in this map. |
Public methods | |
---|---|
void
|
copyGainFactors(float[] destination, int offset)
Copy all gain factors in row-major order from this lens shading map into the destination. |
boolean
|
equals(Object obj)
Check if this LensShadingMap is equal to another LensShadingMap. |
int
|
getColumnCount()
Get the number of columns in this map. |
float
|
getGainFactor(int colorChannel, int column, int row)
Get a single color channel gain factor from this lens shading map by its row and column. |
int
|
getGainFactorCount()
Get the total number of gain factors in this map. |
RggbChannelVector
|
getGainFactorVector(int column, int row)
Get a gain factor vector from this lens shading map by its row and column. |
int
|
getRowCount()
Get the number of rows in this map. |
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Return the LensShadingMap as a string representation. |
Inherited methods | |
---|---|
Constants
MINIMUM_GAIN_FACTOR
public static final float MINIMUM_GAIN_FACTOR
The smallest gain factor in this map.
All values in this map will be at least this large.
Constant Value: 1.0
Public methods
copyGainFactors
public void copyGainFactors (float[] destination, int offset)
Copy all gain factors in row-major order from this lens shading map into the destination.
Each gain factor will be >= MINIMUM_GAIN_FACTOR
.
Parameters | |
---|---|
destination |
float : an array big enough to hold at least RggbChannelVector#COUNT
elements after the offset |
offset |
int : a non-negative offset into the array |
Throws | |
---|---|
NullPointerException |
If destination was null |
IllegalArgumentException |
If offset was negative |
ArrayIndexOutOfBoundsException |
If there's not enough room to write the elements at the specified destination and offset. |
equals
public boolean equals (Object obj)
Check if this LensShadingMap is equal to another LensShadingMap.
Two lens shading maps are equal if and only if they have the same rows/columns,
and all of their elements are equal
.
Parameters | |
---|---|
obj |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if the objects were equal, false otherwise |
getColumnCount
public int getColumnCount ()
Get the number of columns in this map.
Returns | |
---|---|
int |
getGainFactor
public float getGainFactor (int colorChannel, int column, int row)
Get a single color channel gain factor from this lens shading map by its row and column.
The rows must be within the range [0, getRowCount()
),
the column must be within the range [0, getColumnCount()
),
and the color channel must be within the range [0, android.hardware.camera2.params.RggbChannelVector.COUNT RggbChannelVector.COUNT
).
The channel order is [R, Geven, Godd, B]
, where
Geven
is the green channel for the even rows of a Bayer pattern, and
Godd
is the odd rows.
Parameters | |
---|---|
colorChannel |
int : color channel from [R, Geven, Godd, B] |
column |
int : within the range [0, getColumnCount() ) |
row |
int : within the range [0, getRowCount() ) |
Returns | |
---|---|
float |
a gain factor >= .MINIMUM_GAIN_FACTOR |
Throws | |
---|---|
IllegalArgumentException |
if any of the parameters was out of range |
getGainFactorCount
public int getGainFactorCount ()
Get the total number of gain factors in this map.
A single gain factor contains exactly one color channel.
Use with copyGainFactors(float, int)
to allocate a large-enough array.
Returns | |
---|---|
int |
getGainFactorVector
public RggbChannelVector getGainFactorVector (int column, int row)
Get a gain factor vector from this lens shading map by its row and column.
The rows must be within the range [0, getRowCount()
),
the column must be within the range [0, getColumnCount()
).
Parameters | |
---|---|
column |
int : within the range [0, getColumnCount() ) |
row |
int : within the range [0, getRowCount() ) |
Returns | |
---|---|
RggbChannelVector |
an RggbChannelVector where each gain factor >= .MINIMUM_GAIN_FACTOR |
Throws | |
---|---|
IllegalArgumentException |
if any of the parameters was out of range |
See also:
getRowCount
public int getRowCount ()
Get the number of rows in this map.
Returns | |
---|---|
int |
hashCode
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
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 inequals
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 thehashCode
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 thehashCode
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.
Returns | |
---|---|
int |
a hash code value for this object. |
toString
public String toString ()
Return the LensShadingMap as a string representation.
"LensShadingMap{R:([%f, %f, ... %f], ... [%f, %f, ... %f]), G_even:([%f, %f, ...
%f], ... [%f, %f, ... %f]), G_odd:([%f, %f, ... %f], ... [%f, %f, ... %f]), B:([%f, %f, ...
%f], ... [%f, %f, ... %f])}"
,
where each %f
represents one gain factor and each [%f, %f, ... %f]
represents
a row of the lens shading map
Returns | |
---|---|
String |
string representation of LensShadingMap |