---
# System prepended metadata

title: get_candi_region 說明

---

# get_candi_region 說明


## function 
``` python
def get_candi_region(step_object,
                    symbol,
                    search_region,
                    unit,
                    interval = [50,50],
                    check_layer = 'position_check_layer',
                    uncheck_layer = 'position_uncheck_layer',
                    ignore_attr_list = [],
                    consider_attr_list = [] ):
    '''
    This is a general method to set DetectObj for all features.
    The purpose of DetectObj is to find a propert position (no touch to anyothers) for feature.
    Input:
        Symbol   : r100,rect1500x500,s100 #Symbol of detect object.
        unit     : inch or mm
        region   : [xmin,ymin,xmax,ymax]  #region we looking for propert position.
        interval : [dx,dy]
        check_layer        : layer we touch to check if position is ok.
        position_uncheck   : layer we set uncheck symbol.
        ignore_attr_list   : list -> features that we want to ignore.
        consider_attr_list : list -> the only features that we  want to consider.
        note: we can't use both ignore_attr_list and consider_attr_list in the same time
             
        
    Output:
        RefPosLst :[pos1, pos2,...,] 
                   # all candidate position  we select
                  :[]  # if no propert position is found
 
    '''
```
## 使用方式
```python
feasible_xy = get_candi_region(step_object, symbol, search_region,"mm",
                    interval = [50, 50], ignore_attr_list = ['text_mark'])
```
## 注意事項
- 不能同時加入ignore / consider_attr_list
- 每個feature 在auto function的部分，都要加上string屬性。
    - ex: 結束要記得cur_atr_reset![](https://i.imgur.com/aTG7WGC.png)
    