API Reference

This section provides comprehensive API documentation for all modules in the phased_array package. Each function includes parameter descriptions, return values, and usage examples.

Modules

Module	Description
Core Module	Core computation functions: steering vectors, array factor, pattern cuts
Geometry Module	Array geometry creation: rectangular, triangular, circular, conformal, sparse
Beamforming Module	Beamforming techniques: amplitude tapers, null steering, multi-beam
Impairments Module	Realistic impairments: mutual coupling, quantization, failures, scan blindness
Visualization Module	Plotting functions: 2D, 3D, UV-space, Plotly interactive
Wideband Module	Wideband analysis: true time delay, hybrid steering, beam squint
Utilities Module	Utility functions: coordinate transforms, unit conversions
Export Module	Data export: CSV, JSON, NPZ formats

Quick Reference

Most Commonly Used Functions

Array Creation

• create_rectangular_array() - Create rectangular grid

• create_triangular_array() - Create triangular grid

• create_circular_array() - Create circular array

Pattern Computation

• steering_vector() - Compute steering weights

• array_factor_vectorized() - Compute array factor

• compute_full_pattern() - Compute full 3D pattern

Beamforming

• taylor_taper_2d() - Taylor amplitude taper

• null_steering_projection() - Null steering

Visualization

• plot_pattern_contour() - 2D contour plot

• plot_pattern_3d_plotly() - Interactive 3D plot