org.bytedeco.opencv.opencv_core

Class Scalar

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.DoublePointer

org.bytedeco.opencv.opencv_core.AbstractScalar

org.bytedeco.opencv.opencv_core.Scalar

All Implemented Interfaces:

AutoCloseable

@Name(value="cv::Scalar_<double>")
 @Properties(inherit=opencv_core.class)
public class Scalar
extends AbstractScalar

\brief Template class for a 4-element vector derived from Vec.

Being derived from Vec\<_Tp, 4\> , Scalar\_ and Scalar can be used just as typical 4-element vectors. In addition, they can be converted to/from CvScalar . The type Scalar is widely used in OpenCV to pass pixel values.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.opencv.opencv_core.AbstractScalar

ALPHA1, ALPHA255, BLACK, BLUE, CYAN, GRAY, GREEN, MAGENTA, ONE, ONEHALF, RED, WHITE, YELLOW, ZERO

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Scalar() default constructor
Scalar(double v0)
Scalar(double v0, double v1)
Scalar(double v0, double v1, double v2, double v3)
Scalar(Pointer p) Pointer cast constructor.
Scalar(Scalar s)

Method Summary

Modifier and Type	Method and Description
static Scalar	all(double v0) returns a scalar with all elements set to v0
Scalar	conj() returns (v0, -v1, -v2, -v3)
boolean	isReal() returns true iff v1 == v2 == v3 == 0
Scalar	mul(Scalar a)
Scalar	mul(Scalar a, double scale) per-element product
Scalar	put(Scalar s)

Methods inherited from class org.bytedeco.opencv.opencv_core.AbstractScalar

blue, blue, green, green, magnitude, red, red, scale, toString

Methods inherited from class org.bytedeco.javacpp.DoublePointer

asBuffer, capacity, get, get, get, get, limit, position, put, put, put, put, sizeof

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asByteBuffer, availablePhysicalBytes, calloc, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, isNull, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Scalar

public Scalar(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Scalar

public Scalar()

default constructor

Scalar

public Scalar(double v0,
              double v1,
              double v2,
              double v3)

Scalar

public Scalar(double v0,
              double v1)

Scalar

public Scalar(double v0)

Scalar

public Scalar(@Const @ByRef
              Scalar s)

Method Detail

put

@ByRef
 @Name(value="operator =")
public Scalar put(@Const @ByRef
                                                    Scalar s)

all

@ByVal
public static Scalar all(double v0)

returns a scalar with all elements set to v0

mul

@ByVal
public Scalar mul(@Const @ByRef
                         Scalar a,
                         double scale)

per-element product

mul

@ByVal
public Scalar mul(@Const @ByRef
                         Scalar a)

conj

@ByVal
public Scalar conj()

returns (v0, -v1, -v2, -v3)

isReal

@Cast(value="bool")
public boolean isReal()

returns true iff v1 == v2 == v3 == 0