> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ntop.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Filter Beams by Direction

> AI context for Filter Beams by Direction. Not linked in navigation.

> This page is for AI assistant context only. To use this package, visit [community.ntop.com](https://community.ntop.com/packages/DaveMakesStuff/filter-beams-by-direction).

> **Community submission — not verified by nTop.** This package was submitted by an outside community member and has not been reviewed or verified by nTop. Treat its accuracy, safety, and compatibility claims with appropriate caution.

## Summary

Filter lattice beams by direction using a scalar field.

## Package Details

| Field            | Value                                              |
| ---------------- | -------------------------------------------------- |
| **ID**           | `filter-beams-by-direction`                        |
| **Type**         | Block                                              |
| **Author**       | DaveMakesStuff                                     |
| **Version**      | 0.1.0                                              |
| **nTop Version** | 4.12+                                              |
| **Domain**       | Geometry                                           |
| **Complexity**   | Intermediate                                       |
| **Tags**         | `lattice`, `graph`, `direction`, `beams`, `filter` |
| **License**      | MIT                                                |
| **Verified**     | No                                                 |

***

Filter lattice beams by direction using a scalar field. Select whether to filter for beams that are either parallel or perpendicular to the field gradient. The "Extent" input determines how much the selected beams adhere to the "parallel" or "perpendicular" criteria. An "Extent" value of 1 return beams that meet the criteria exactly, while a value of 0 returns all beams. A warning is given if no beams meet the criteria.

## Installation

Clone this repo or copy the package folder into your nTop workspace:

```bash theme={null}
git clone https://github.com/nTopology/Utilities.git
```

The package lives at `packages/DaveMakesStuff/filter-beams-by-direction/`.

## Usage

1. Open the provided `.ntop` file in nTop 4.12+.
2. Input lattice and apply selection criteria

## Inputs & outputs

| Name               | Type         | Notes                                                                                                 |
| ------------------ | ------------ | ----------------------------------------------------------------------------------------------------- |
| `Lattice`          | Lattice      | Lattice to evaluate                                                                                   |
| `Direction Field`  | Scalar Field | The gradient of this field is used to filter beams                                                    |
| `Filter for`       | Choice       | Select to filter beams parallel or perpendicular to field gradient                                    |
| `Extent`           | Scalar Value | Scalar value between 0 and 1 to determine how strictly selected beams adhere to "Filter for" criteria |
| `Filtered Lattice` | Lattice      | Main Result                                                                                           |

## License

MIT.

***

## Source

[https://community.ntop.com/packages/DaveMakesStuff/filter-beams-by-direction](https://community.ntop.com/packages/DaveMakesStuff/filter-beams-by-direction)