Struct opencv::hfs::HfsSegment

pub struct HfsSegment { /* private fields */ }

Implementations

impl HfsSegment

pub fn create( height: i32, width: i32, seg_egb_threshold_i: f32, min_region_size_i: i32, seg_egb_threshold_ii: f32, min_region_size_ii: i32, spatial_weight: f32, slic_spixel_size: i32, num_slic_iter: i32 ) -> Result<Ptr<HfsSegment>>

create a hfs object

Parameters

• height: : the height of the input image
• width: : the width of the input image
• segEgbThresholdI: : parameter segEgbThresholdI
• minRegionSizeI: : parameter minRegionSizeI
• segEgbThresholdII: : parameter segEgbThresholdII
• minRegionSizeII: : parameter minRegionSizeII
• spatialWeight: : parameter spatialWeight
• slicSpixelSize: : parameter slicSpixelSize
• numSlicIter: : parameter numSlicIter

C++ default parameters

• seg_egb_threshold_i: 0.08f
• min_region_size_i: 100
• seg_egb_threshold_ii: 0.28f
• min_region_size_ii: 200
• spatial_weight: 0.6f
• slic_spixel_size: 8
• num_slic_iter: 5

pub fn create_def(height: i32, width: i32) -> Result<Ptr<HfsSegment>>

create a hfs object

Parameters

• height: : the height of the input image
• width: : the width of the input image
• segEgbThresholdI: : parameter segEgbThresholdI
• minRegionSizeI: : parameter minRegionSizeI
• segEgbThresholdII: : parameter segEgbThresholdII
• minRegionSizeII: : parameter minRegionSizeII
• spatialWeight: : parameter spatialWeight
• slicSpixelSize: : parameter slicSpixelSize
• numSlicIter: : parameter numSlicIter

Note

This alternative version of HfsSegment::create function uses the following default values for its arguments:

• seg_egb_threshold_i: 0.08f
• min_region_size_i: 100
• seg_egb_threshold_ii: 0.28f
• min_region_size_ii: 200
• spatial_weight: 0.6f
• slic_spixel_size: 8
• num_slic_iter: 5

Trait Implementations

impl AlgorithmTrait for HfsSegment

fn as_raw_mut_Algorithm(&mut self) -> *mut c_void

fn clear(&mut self) -> Result<()>

Clears the algorithm state

fn read(&mut self, fn_: &impl FileNodeTraitConst) -> Result<()>

Reads algorithm parameters from a file storage

impl AlgorithmTraitConst for HfsSegment

fn as_raw_Algorithm(&self) -> *const c_void

fn write(&self, fs: &mut impl FileStorageTrait) -> Result<()>

Stores algorithm parameters in a file storage

fn write_1(&self, fs: &mut impl FileStorageTrait, name: &str) -> Result<()>

Stores algorithm parameters in a file storage

fn write_with_name(&self, fs: &Ptr<FileStorage>, name: &str) -> Result<()>

@deprecated

fn write_with_name_def(&self, fs: &Ptr<FileStorage>) -> Result<()>

👎Deprecated:

Note

Deprecated: ## Note This alternative version of AlgorithmTraitConst::write_with_name function uses the following default values for its arguments:

fn empty(&self) -> Result<bool>

Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read

fn save(&self, filename: &str) -> Result<()>

Saves the algorithm to a file. In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).

fn get_default_name(&self) -> Result<String>

Returns the algorithm string identifier. This string is used as top level xml/yml node tag when the object is saved to a file or string.

impl Boxed for HfsSegment

unsafe fn from_raw(ptr: <HfsSegment as OpenCVFromExtern>::ExternReceive) -> Self

Wrap the specified raw pointer

fn into_raw(self) -> <HfsSegment as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> <HfsSegment as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut( &mut self ) -> <HfsSegment as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Debug for HfsSegment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for HfsSegment

fn drop(&mut self)

Executes the destructor for this type.

impl From<HfsSegment> for Algorithm

fn from(s: HfsSegment) -> Self

Converts to this type from the input type.

impl HfsSegmentTrait for HfsSegment

fn as_raw_mut_HfsSegment(&mut self) -> *mut c_void

fn set_seg_egb_threshold_i(&mut self, c: f32) -> Result<()>

set and get the parameter segEgbThresholdI. This parameter is used in the second stage mentioned above. It is a constant used to threshold weights of the edge when merging adjacent nodes when applying EGB algorithm. The segmentation result tends to have more regions remained if this value is large and vice versa.

fn get_seg_egb_threshold_i(&mut self) -> Result<f32>

fn set_min_region_size_i(&mut self, n: i32) -> Result<()>

set and get the parameter minRegionSizeI. This parameter is used in the second stage mentioned above. After the EGB segmentation, regions that have fewer pixels then this parameter will be merged into it’s adjacent region.

fn get_min_region_size_i(&mut self) -> Result<i32>

fn set_seg_egb_threshold_ii(&mut self, c: f32) -> Result<()>

set and get the parameter segEgbThresholdII. This parameter is used in the third stage mentioned above. It serves the same purpose as segEgbThresholdI. The segmentation result tends to have more regions remained if this value is large and vice versa.

fn get_seg_egb_threshold_ii(&mut self) -> Result<f32>

fn set_min_region_size_ii(&mut self, n: i32) -> Result<()>

set and get the parameter minRegionSizeII. This parameter is used in the third stage mentioned above. It serves the same purpose as minRegionSizeI

fn get_min_region_size_ii(&mut self) -> Result<i32>

fn set_spatial_weight(&mut self, w: f32) -> Result<()>

set and get the parameter spatialWeight. This parameter is used in the first stage mentioned above(the SLIC stage). It describes how important is the role of position when calculating the distance between each pixel and it’s center. The exact formula to calculate the distance is inline formula. The segmentation result tends to have more local consistency if this value is larger.

fn get_spatial_weight(&mut self) -> Result<f32>

fn set_slic_spixel_size(&mut self, n: i32) -> Result<()>

set and get the parameter slicSpixelSize. This parameter is used in the first stage mentioned above(the SLIC stage). It describes the size of each superpixel when initializing SLIC. Every superpixel approximately has inline formula pixels in the beginning.

fn get_slic_spixel_size(&mut self) -> Result<i32>

fn set_num_slic_iter(&mut self, n: i32) -> Result<()>

set and get the parameter numSlicIter. This parameter is used in the first stage. It describes how many iteration to perform when executing SLIC.

fn get_num_slic_iter(&mut self) -> Result<i32>

fn perform_segment_gpu( &mut self, src: &impl ToInputArray, if_draw: bool ) -> Result<Mat>

do segmentation gpu

fn perform_segment_gpu_def(&mut self, src: &impl ToInputArray) -> Result<Mat>

do segmentation gpu

fn perform_segment_cpu( &mut self, src: &impl ToInputArray, if_draw: bool ) -> Result<Mat>

do segmentation with cpu This method is only implemented for reference. It is highly NOT recommanded to use it.

fn perform_segment_cpu_def(&mut self, src: &impl ToInputArray) -> Result<Mat>

do segmentation with cpu This method is only implemented for reference. It is highly NOT recommanded to use it.

impl HfsSegmentTraitConst for HfsSegment

fn as_raw_HfsSegment(&self) -> *const c_void

impl Send for HfsSegment