openlifu.plan.solution_analysis.SolutionAnalysisOptions

class openlifu.plan.solution_analysis.SolutionAnalysisOptions(standoff_sound_speed: "Annotated[float, OpenLIFUFieldData('Standoff sound speed (m/s)', 'Speed of sound in standoff, for calculating initial impedance')]" = 1500.0, standoff_density: "Annotated[float, OpenLIFUFieldData('Standoff density (kg/m³)', 'Density of standoff medium (kg/m³)')]" = 1000.0, ref_sound_speed: "Annotated[float, OpenLIFUFieldData('Reference sound speed (m/s)', 'Reference speed of sound in the medium (m/s)')]" = 1500.0, ref_density: "Annotated[float, OpenLIFUFieldData('Reference density (kg/m³)', 'Reference density (kg/m³)')]" = 1000.0, mainlobe_aspect_ratio: "Annotated[Tuple[float, float, float], OpenLIFUFieldData('Mainlobe aspect ratio (lat,ele,ax)', 'Aspect ratio of the mainlobe mask')]" = (1.0, 1.0, 5.0), mainlobe_radius: "Annotated[float, OpenLIFUFieldData('Mainlobe mask radius', 'Size of the mainlobe mask, in the units provided for Distance units (`distance_units`)')]" = 0.0025, beamwidth_radius: "Annotated[float, OpenLIFUFieldData('Beamwidth search radius', 'Size of the beamwidth search, in the units provided for Distance units (`distance_units`)')]" = 0.005, sidelobe_radius: "Annotated[float, OpenLIFUFieldData('Sidelobe radius', 'Size of the sidelobe mask, in the units provided for Distance units (`distance_units`)')]" = 0.003, sidelobe_zmin: "Annotated[float, OpenLIFUFieldData('Sidelobe minimum z', 'Minimum z coordinate of the sidelobe mask, in the units provided for Distance units (`distance_units`)')]" = 0.001, distance_units: "Annotated[str, OpenLIFUFieldData('Distance units', 'The units used for distance measurements')]" = 'm', param_constraints: "Annotated[Dict[str, ParameterConstraint], OpenLIFUFieldData('Parameter constraints', None)]" = <factory>)

Bases: DictMixin

beamwidth_radius: Annotated[float, OpenLIFUFieldData(name='Beamwidth search radius', description='Size of the beamwidth search, in the units provided for Distance units (`distance_units`)')] = 0.005

Size of the beamwidth search, in the units provided for Distance units (distance_units). The beamwidth is found along the lateral and elevation lines perpendicular to the focus axis.

distance_units: Annotated[str, OpenLIFUFieldData(name='Distance units', description='The units used for distance measurements')] = 'm'

The units used for distance measurements

classmethod from_dict(parameter_dict: Dict[str, Any]) → SolutionAnalysisOptions

Create an object from a dictionary

Parameters:

parameter_dict – dictionary of parameters to define the object

Returns: new object

mainlobe_aspect_ratio: Annotated[Tuple[float, float, float], OpenLIFUFieldData(name='Mainlobe aspect ratio (lat,ele,ax)', description='Aspect ratio of the mainlobe mask')] = (1.0, 1.0, 5.0)

Aspect ratio of the mainlobe ellipsoid mask, in the form (lat,ele,ax). (1,1,5) means an ellipsoid 5x as long as it is wide.

mainlobe_radius: Annotated[float, OpenLIFUFieldData(name='Mainlobe mask radius', description='Size of the mainlobe mask, in the units provided for Distance units (`distance_units`)')] = 0.0025

Size of the mainlobe mask, in the units provided for Distance units (distance_units). The mainlobe mask is an ellipsoid with this radius, scaled by the mainlobe_aspect_ratio.

param_constraints: Annotated[Dict[str, ParameterConstraint], OpenLIFUFieldData(name='Parameter constraints', description=None)]

Add description

Type:

TODO

ref_density: Annotated[float, OpenLIFUFieldData(name='Reference density (kg/m³)', description='Reference density (kg/m³)')] = 1000.0

Reference density (kg/m³)

ref_sound_speed: Annotated[float, OpenLIFUFieldData(name='Reference sound speed (m/s)', description='Reference speed of sound in the medium (m/s)')] = 1500.0

Reference speed of sound in the medium (m/s)

sidelobe_radius: Annotated[float, OpenLIFUFieldData(name='Sidelobe radius', description='Size of the sidelobe mask, in the units provided for Distance units (`distance_units`)')] = 0.003

Size of the sidelobe mask, in the units provided for Distance units (distance_units). Pressure outside of this ellipsoid (scaled by mainlobe_aspect_ratio) is considered outside of the focal region.

sidelobe_zmin: Annotated[float, OpenLIFUFieldData(name='Sidelobe minimum z', description='Minimum z coordinate of the sidelobe mask, in the units provided for Distance units (`distance_units`)')] = 0.001

Minimum z coordinate of the sidelobe mask, in the units provided for Distance units (distance_units). This value is used to ignore emitted pressure artifacts.

standoff_density: Annotated[float, OpenLIFUFieldData(name='Standoff density (kg/m³)', description='Density of standoff medium (kg/m³)')] = 1000.0

Density of standoff medium (kg/m³)

standoff_sound_speed: Annotated[float, OpenLIFUFieldData(name='Standoff sound speed (m/s)', description='Speed of sound in standoff, for calculating initial impedance')] = 1500.0

Speed of sound in standoff, for calculating initial impedance