Trait opencv::imgproc::LineIteratorTrait

pub trait LineIteratorTrait {
    pub fn as_raw_LineIterator(&self) -> *const c_void;
    pub fn as_raw_mut_LineIterator(&mut self) -> *mut c_void;

    pub fn ptr(&mut self) -> &mut u8 { ... }
    pub fn set_ptr(&mut self, val: &mut u8) { ... }
    pub fn ptr0(&self) -> &u8 { ... }
    pub fn step(&self) -> i32 { ... }
    pub fn set_step(&mut self, val: i32) { ... }
    pub fn elem_size(&self) -> i32 { ... }
    pub fn set_elem_size(&mut self, val: i32) { ... }
    pub fn err(&self) -> i32 { ... }
    pub fn set_err(&mut self, val: i32) { ... }
    pub fn count(&self) -> i32 { ... }
    pub fn set_count(&mut self, val: i32) { ... }
    pub fn minus_delta(&self) -> i32 { ... }
    pub fn set_minus_delta(&mut self, val: i32) { ... }
    pub fn plus_delta(&self) -> i32 { ... }
    pub fn set_plus_delta(&mut self, val: i32) { ... }
    pub fn minus_step(&self) -> i32 { ... }
    pub fn set_minus_step(&mut self, val: i32) { ... }
    pub fn plus_step(&self) -> i32 { ... }
    pub fn set_plus_step(&mut self, val: i32) { ... }
    pub fn minus_shift(&self) -> i32 { ... }
    pub fn set_minus_shift(&mut self, val: i32) { ... }
    pub fn plus_shift(&self) -> i32 { ... }
    pub fn set_plus_shift(&mut self, val: i32) { ... }
    pub fn p(&self) -> Point { ... }
    pub fn set_p(&mut self, val: Point) { ... }
    pub fn ptmode(&self) -> bool { ... }
    pub fn set_ptmode(&mut self, val: bool) { ... }
    pub fn init(
        &mut self, 
        img: &Mat, 
        bounding_area_rect: Rect, 
        pt1: Point, 
        pt2: Point, 
        connectivity: i32, 
        left_to_right: bool
    ) -> Result<()> { ... }
    pub fn try_deref_mut(&mut self) -> Result<&mut u8> { ... }
    pub fn pos(&self) -> Result<Point> { ... }
}

Line iterator

The class is used to iterate over all the pixels on the raster line segment connecting two specified points.

The class LineIterator is used to get each pixel of a raster line. It can be treated as versatile implementation of the Bresenham algorithm where you can stop at each pixel and do some extra processing, for example, grab pixel values along the line or draw a line with an effect (for example, with XOR operation).

The number of pixels along the line is stored in LineIterator::count. The method LineIterator::pos returns the current position in the image:

// grabs pixels along the line (pt1, pt2)
// from 8-bit 3-channel image to the buffer
LineIterator it(img, pt1, pt2, 8);
LineIterator it2 = it;
vector<Vec3b> buf(it.count);
 
for(int i = 0; i < it.count; i++, ++it)
   buf[i] = *(const Vec3b*)*it;
 
// alternative way of iterating through the line
for(int i = 0; i < it2.count; i++, ++it2)
{
   Vec3b val = img.at<Vec3b>(it2.pos());
   CV_Assert(buf[i] == val);
}

Required methods

pub fn as_raw_LineIterator(&self) -> *const c_void

pub fn as_raw_mut_LineIterator(&mut self) -> *mut c_void

Loading content...

Provided methods

pub fn ptr(&mut self) -> &mut u8

pub fn set_ptr(&mut self, val: &mut u8)

pub fn ptr0(&self) -> &u8

pub fn step(&self) -> i32

pub fn set_step(&mut self, val: i32)

pub fn elem_size(&self) -> i32

pub fn set_elem_size(&mut self, val: i32)

pub fn err(&self) -> i32

pub fn set_err(&mut self, val: i32)

pub fn count(&self) -> i32

pub fn set_count(&mut self, val: i32)

pub fn minus_delta(&self) -> i32

pub fn set_minus_delta(&mut self, val: i32)

pub fn plus_delta(&self) -> i32

pub fn set_plus_delta(&mut self, val: i32)

pub fn minus_step(&self) -> i32

pub fn set_minus_step(&mut self, val: i32)

pub fn plus_step(&self) -> i32

pub fn set_plus_step(&mut self, val: i32)

pub fn minus_shift(&self) -> i32

pub fn set_minus_shift(&mut self, val: i32)

pub fn plus_shift(&self) -> i32

pub fn set_plus_shift(&mut self, val: i32)

pub fn p(&self) -> Point

pub fn set_p(&mut self, val: Point)

pub fn ptmode(&self) -> bool

pub fn set_ptmode(&mut self, val: bool)

pub fn init(
    &mut self,
    img: &Mat,
    bounding_area_rect: Rect,
    pt1: Point,
    pt2: Point,
    connectivity: i32,
    left_to_right: bool
) -> Result<()>

pub fn try_deref_mut(&mut self) -> Result<&mut u8>

returns pointer to the current pixel

pub fn pos(&self) -> Result<Point>

returns coordinates of the current pixel

Loading content...

Implementors

impl LineIteratorTrait for LineIterator

pub fn as_raw_LineIterator(&self) -> *const c_void

pub fn as_raw_mut_LineIterator(&mut self) -> *mut c_void

Loading content...