org.bytedeco.opencv.opencv_core

Class Range

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_core.Range

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

_Range

@Namespace(value="cv")
 @NoOffset
 @Properties(inherit=opencv_core.class)
public class Range
extends Pointer

\brief Template class specifying a continuous subsequence (slice) of a sequence.

The class is used to specify a row or a column span in a matrix ( Mat ) and for many other purposes. Range(a,b) is basically the same as a:b in Matlab or a..b in Python. As in Python, start is an inclusive left boundary of the range and end is an exclusive right boundary of the range. Such a half-opened interval is usually denoted as [start,end) .

The static method Range::all() returns a special variable that means "the whole sequence" or "the whole range", just like " : " in Matlab or " ... " in Python. All the methods and functions in OpenCV that take Range support this special Range::all() value. But, of course, in case of your own custom processing, you will probably have to check and handle it explicitly:

    void my_function(..., const Range& r, ....)
    {
        if(r == Range::all()) {
            // process all the data
        }
        else {
            // process [r.start, r.end)
        }
    }

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.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Range()
Range(int _start, int _end)
Range(long size) Native array allocator.
Range(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
static Range	all()
boolean	empty()
int	end()
Range	end(int setter)
Range	position(long position)
int	size()
int	start()
Range	start(int setter)

Methods inherited from class org.bytedeco.javacpp.Pointer

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Range

public Range(Pointer p)

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

Range

public Range(long size)

Native array allocator. Access with Pointer.position(long).

Range

public Range()

Range

public Range(int _start,
             int _end)

Method Detail

position

public Range position(long position)

Overrides:

position in class Pointer

size

public int size()

empty

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

all

@ByVal
public static Range all()

start

public int start()

start

public Range start(int setter)

end

public int end()

end

public Range end(int setter)