get_search_info_by_register_id

SurfaceSearch.get_search_info_by_register_id(face_zonelets, register_id, params)

Gets search information regarding registered face elements of provided zonelets using a register id.

Parameters:

face_zoneletsIterable[int]

Ids of the face zonelets to search in.

register_idint

An integer register id.

paramsSearchInfoByRegisterIdParams

Parameters for retrieveing information on registered faces.

Returns:

:

SearchInfoByRegisterIdResults

Returns the SearchInfoByRegisterIdResults.

Return type:

SearchInfoByRegisterIdResults

Examples

>>> surf_search = SurfaceSearch(model=model)
>>> params = prime.SearchInfoByRegisterIdParams(model=model)
>>> results = surf_search.get_search_info_by_register_id(face_zonelets, register_id, params)