Resource Base
Table of contents

CPredetectedRegionsUnit

The CPredetectedRegionsUnit class represents a unit that contains a collection of pre-detected regions. It inherits from the CIntermediateResultUnit class and stores the result of image color pre-detection.

Definition

Namespace: dynamsoft::intermediate_results

Assembly: DynamsoftCore

class CPredetectedRegionsUnit : public CIntermediateResultUnit

Methods Summary

Method Description
GetCount Gets the number of pre-detected regions in the collection.
GetPredetectedRegion Gets a pointer to a specific pre-detected region in the collection.
operator[] Gets a pointer to a specific pre-detected region in the collection.
RemoveAllPredetectedRegions Removes all pre-detected regions in the unit.
RemovePredetectedRegion Removes a pre-detected region in the unit at the specified index.
AddPredetectedRegion Adds a pre-detected region in the unit.
SetPredetectedRegion Sets a pre-detected region in the unit at the specified index.

Inherited Methods

The following methods are inherited from class CIntermediateResultUnit.

Method Description
GetHashId Gets the hash ID of the unit.
GetOriginalImageHashId Gets the hash ID of the original image.
GetOriginalImageTag Gets the image tag of the original image.
GetType Gets the type of the intermediate result unit.
Clone Creates a copy of the intermediate result unit.
SetHashId Sets the hash ID of the unit.
SetOriginalImageHashId Sets the hash ID of the original image.
SetOriginalImageTag Sets the image tag of the original image.
Retain Increases the reference count of the unit.
Release Decreases the reference count of the unit.
GetTransformMatrix Gets the transformation matrix via TransformMatrixType.
SetTransformMatrix Sets the transformation matrix via TransformMatrixType.

GetCount

Gets the number of pre-detected regions in the collection.

virtual int GetCount() const

Return value

Returns the number of pre-detected regions in the collection.

GetPredetectedRegion

Gets a pointer to a specific pre-detected region in the collection.

virtual const CPredetectedRegionElement* GetPredetectedRegion(int index) const

Parameters

[in] index The index of the pre-detected region to retrieve.

Return value

Returns a const pointer to the specified pre-detected region in the collection. You don’t need to release the memory pointed to by the returned pointer.

See Also

CPredetectedRegionElement

operator[]

Gets a pointer to a specific pre-detected region in the collection.

virtual const CPredetectedRegionElement* operator[](int index) const = 0;

Parameters

[in] index The index of the pre-detected region to retrieve.

Return Value

Returns a const pointer to the specified pre-detected region in the collection. You don’t need to release the memory pointed to by the returned pointer.

RemoveAllPredetectedRegions

Removes all pre-detected regions in the unit.

virtual void RemoveAllPredetectedRegions() = 0;

RemovePredetectedRegion

Removes a pre-detected region in the unit at the specified index.

virtual int RemovePredetectedRegion(int index) = 0;

Parameters

[in] index The index of the pre-detected region to remove.

Return Value

Returns 0 if succeeds, nonzero otherwise.

AddPredetectedRegion

Adds a pre-detected region in the unit.

virtual int AddPredetectedRegion(const CPredetectedRegionElement* element, const double matrixToOriginalImage[9] =  IDENTITY_MATRIX) = 0;

Parameters

[in] element The pre-detected region to add.

Return Value

Returns 0 if succeeds, nonzero otherwise.

SetPredetectedRegion

Sets a pre-detected region in the unit at the specified index.

virtual int SetPredetectedRegion(int index, const CPredetectedRegionElement* element, const double matrixToOriginalImage[9] =  IDENTITY_MATRIX) = 0;

Parameters

[in] index The index of the pre-detected region to set. [in] element The pre-detected region to set.

Return Value

Returns 0 if succeeds, nonzero otherwise.

This page is compatible for:

Version 1.0

Is this page helpful?

YesYes NoNo

In this article:

latest version

  • Latest version (2.2.0)
  • Version 2.x
    • Version 2.0.30
    • Version 2.0.20
    • Version 2.0.10
    • Version 2.0.0
Change +
© 2003–2024 Dynamsoft. All rights reserved.
Privacy Statement / Site Map / Home / Purchase / Support