astro py:docs

- Index
- Modules

### Navigation

- next »
- « previous |
- Astropy v5.2.1 »
- Models and Fitting (`astropy.modeling`) »
- Reference/API »
- bind_compound_bounding_box

# bind_compound_bounding_box

astropy.modeling.bind_compound_bounding_box(modelinstance, bounding_boxes, selector_args, create_selector=None, ignored=None, order='C')

  Add a validated compound bounding box to a model instance.

  Parameters:
    modelinstance `Model` instance

      This is the model that the validated compound bounding box will be set on.

    bounding_boxes `python:dict`

      A dictionary of bounding box tuples, see Efficient Model Rendering with Bounding Boxes for details.

    selector_args `python:list`

      List of selector argument tuples to define selection for compound bounding box, see Efficient Model Rendering with Bounding Boxes for details.

    create_selector `python:callable()`, optional

      An optional callable with interface (selector_value, model) which can generate a bounding box based on a selector value and model if there is no bounding box in the compound bounding box listed under that selector value. Default is `None`, meaning new bounding box entries will not be automatically generated.

    ignored `python:list`

      List of the inputs to be ignored by the bounding box.

    order `python:str`, optional

      The ordering of the bounding box tuple, can be either `'C'` or `'F'`.