Product Documentation
Virtuoso Space-based Router Command Reference
Product Version IC23.1, September 2023

find_shape

find_shape 
[ -layer s_layerExpr ] 
[ -purpose s_purposeExpr ]
[ -set d_setObj | -window_id i_windowID ] 
[ -region {f_xlo f_ylo f_xhi f_yhi} | {{f_x1 f_y1} {f_x2 f_y2}{f_xn f_yn}} ] 
[ -use_regions_on_scratch_layer i_scratchID ] 
[ -ignore_case ] 
[ -depth i_level ] 
[ -fully_enclosed [ true | false ] ] 
[ -granularity [shape | route | route_only | net] ] 
[ -no_net ] 
[ -no_wildcard ] 
[ -on_net ] 
[ -shape_types {[rectangle ] [octagon] [polygon] [routevia] [routeseg] [guide ] [annotation] [text]} ] 
[ -silent ] 

Description

Searches for shapes matching the given criteria.

The GUI equivalent for this command is Edit—Find (Shape).

Arguments

-depth i_level

Specifies the depth of the hierarchy to search. A value of 0 chooses the top-level only and is the default value.

-fully_enclosed [ true | false ]

When true, only finds shapes that are fully enclosed in the specified region.

-granularity s_option

When a routing shape is found by this command, this argument chooses the objects to include in the return set.

  

net

Chooses the routing shape’s net. This is the same functionality as interactive Routing Object Granularity—Entire Net.

  

route

Chooses the routing shape’s route, including connected pins or terms under the route.

  

route_only

Chooses the routing shape’s route. This is the same functionality as interactive Routing Object Granularity—Entire Route.

  

shape

(Default) Chooses the shape. This is the same functionality as interactive Routing Object Granularity—Shape or Via.

-ignore_case

Performs a case-insensitive search.

-layer s_layerExpr

Finds all shapes existing on layers whose names match the given expression. The expression can include special characters described in Pattern Matching. If this argument is not specified, all shapes on all layers within the specified scope meet the criteria.

-no_net

Restricts search to shapes that have no nets assigned to them.

-no_wildcard

Disables all wildcard processing.

-on_net

Restricts search to shapes that are on nets.

-purpose s_purposeExpr

  

Finds all shapes existing on layer purposes whose names match the given expression. The expression can include special characters described in Pattern Matching. If this argument is not specified, all shapes names on all purposes within the specified scope meet the criteria.

-region {f_xlo f_ylo f_xhi f_yhi} | {{f_x1 f_y1} {f_x2 f_y2} {f_xn f_yn}}

Specifies the search area using either the lower-left (f_xlo, f_ylo) and the upper-right (f_xhi, f_yhi) bounding box coordinates, or the x and y coordinate points for a polygon boundary. If you use the -set argument, the -region is ignored.

-set d_setObj

Limits the search to shapes in the specified set.

-shape_types {[rectangle ] [octagon] [polygon] [routevia] [routeseg] [guide ] [annotation] [text]}

Specifies one or more shape types to search for. If this argument is not given, all shapes are considered.

-silent

Suppresses informational messages, such as the number of items found. By default, these messages are output.

-use_regions_on_scratch_layer i_scratchID

Finds shapes that overlap or are fully enclosed (if -fully_enclosed is true) by shapes on the given scratch layer. By defining shapes on a scratch layer, you can effectively search multiple rectangular or rectilinear regions. To specify shapes on a scratch layer, refer to geom_add_shape.

-window_id i_windowID

Limits the search to shapes in the specified window.

Value Returned

d_setObj

Returns the identifier for a set containing all shapes that meet the criteria within the specified set or cellview.

Examples

The following example searches for shapes on layer met1 with purpose wire:detail and saves the found shaped in the set named met_wire_detail.

set met_wire_detail [find_shape -layer met1 -purpose wire:detail -cell_view_id [get_cell_view_id]]

Related Topics

Edit Commands

geom_add_shape


Return to top
 ⠀
X