Function List
- Arrays
- create_circ_csaThis function creates a cylindrical section array of circular transducers.
- create_circ_planar_arrayThis function creates a planar array of circular transducers.
- create_circ_ssaThis function creates a spherical section array of circular transducers.
- create_rect_csaThis function creates a cylindrical section array of rectangular transducers.
- create_rect_planar_arrayThis function creates a planar array of rectangular transducers.
- create_rect_ssaCreates a spherical section array of rectangular transducers.
- create_spherical_shell_planar_arrayCreates a planar array of spherical shell transducers.
- draw_arrayThis function creates a 3D representation of an arbitrary array of FOCUS transducers.
- draw_circThis is a helper function to draw the circular transducers, it is used by the draw_array function. Users are not expected to use this function.
- draw_rectThis is a helper function to draw the rectangular transducers, it is used by the draw_array function. Users are not expected to use this function.
- draw_sphericalshellThis is a helper function to draw a single spherical shell transducer, it is used by the draw_array function. Users are not expected to use this function.
- get_circThis function creates a circular transducer. It is intended to work with the create_circ_arrray functions, but it can be used independently.
- get_rectCreates a rectangular transducer. It is intended to work with the create_rect_array functions, but it can be used independently.
- get_spherical_shellThis function creates a spherical shell transducer. It is intended to be used independently.
- Computation
- asa_callThis function will call the C++ binary ASA routine in the final version of the program, right now it calls the Matlab protected file that has the ASA functionality. This function does not have any error checking but will abort if an insufficient number of arguments is passed.
- asa_runIdentical to asa_call but with more error checking and some sanity checking to ensure a proper calculation will occur.
- farfield_cwCalculates the farfield pressure field generated by a transducer array.
- fftw_asaThis function is the C++ binary that implements the Angular Spectrum Approach. It should not be used in any scripts or used directly, as the interface can change. Use asa_call to ensure consistency. Documentation has been omitted. This is a mex function, if it doesn't run please e-mail focus@egr.msu.edu for help.
- fnm_callThis function is the gateway between the Matlab and C++ binary. It does minimal error checking to ensure enough arguments are being passed.
- fnm_cwThis function is the C++ binary that implements the FNM. It should not be used in any scripts or used directly, as the interface can change. Use fnm_call to ensure consistency. Documentation has been omitted. This is a mex function, if it doesn't run please e-mail focus@egr.msu.edu for help.
- fnm_cw_apodizedComputes the pressure from pistons or arrays under continuous wave excitation in homogeneous media.
- fnm_cw_singleComputes the pressure from pistons under continuous wave excitation in homogeneous media.
- fnm_runThis function is a guided function that does error checking and sanity checks on the input before feeding the information to the C++ binary to get the answer.
- fnm_transient
- fnm_transient_callCalculates the transient pressure field from an arbitrary transducer array using the Fast Nearfield Method.
- fnm_tsdCalculates the transient pressure field from an arbitrary transducer array using the Fast Nearfield Method.
- impulse_begin_and_end_timesFinds start and end times for impulse response calculations.
- impulse_responseCalculates the impulse response of a transducer array.
- rayleigh_cwCalculates pressure field generated by a transducer array in homogeneous media using the Rayleigh-Sommerfeld Integral.
- rayleigh_cw_apodizedCalculates pressure field generated by a transducer array in homogeneous media using the Rayleigh-Sommerfeld Integral.
- rayleigh_transientCalculates pressure field generated by a transducer array in homogeneous media using the Rayleigh-Sommerfeld Integral.
- set_center_coordinate_gridCreates a coordinate grid centered at the given point.
- set_coordinate_gridCreates a coordinate grid data structure used by FOCUS for various calculations.
- set_excitation_functionA function to create an excitation function suitable for use with fnm_transient_call and other transient based codes.
- set_time_samplesCreate a time sample struct for use with transient functions.
- Deprecated
- find_phaseThis function finds a phase adjustment for each transducer such that the phase of all transducers at a given point is the same. This function will likely undergo some significant changes in the near future, but the overall form should remain the same.
- get_pressureThis function is to help people who are unfamiliar with Matlab matrix manipulation features to extract a pressure plane.
- make_tissuestructCreate a structure representing multiple layers of different tissues.
- set_parametersCreate a parameter struct for use with FNM functions.
- set_temporal_coordinate_gridCreates a coordinate grid for use with transient functions.
- Focusing
- find_multiple_focus_phasefind_multiple_focus_phase will produce an array of complex_weight shifts to focus an array defined by xdc at a the given points.
- find_single_focus_phasefind_single_focus_phase will produce an array of complex_weight shifts to focus an array defined by xdc at a given point (x,y,z).
- set_apodizationThis function is used to apodize transducer arrays by setting the complex weights of the individual transducers.
- set_digitized_time_delaysDetermine the time delays needed to focus a transducer array at the given point. Time delays are shifted to fit the temporal grid rather than being allowed to fall between temporal samples.
- set_time_delaysDetermine the time delays required to focus a transducer array at a given point. Time delays calculated with set_time_delays may fall between temporal samples. If this is unacceptable, use set_digitized_time_delays.
- Media
- define_mediaGenerates pre-set media usable for any calculation
- get_tissuestructCreate a structure representing multiple layers of different tissues.
- set_mediumCreate a medium struct for use with other FOCUS functions.
- Support
- pause2This is a call back function used by the C++ binary to force an update of the Matlab display buffer. It should not be changed or deleted under any circumstance. If this function is missing, the program WILL NOT WORK.
- rotate_vector_forwardInterprets Euler angles to rotate vectors.
- trans_rotThis is an internal function used by draw_array and its related functions. Users are not expected to use this function. It is designed to interpret Euler angles.
- pause2Unable to load function documentation from doc_gen.php/pause2.tex.
- rotate_vector_forwardUnable to load function documentation from doc_gen.php/rotate_vector_forward.tex.
- trans_rotUnable to load function documentation from doc_gen.php/trans_rot.tex.
- pause2Unable to load function documentation from index.php/pause2.tex.
- rotate_vector_forwardUnable to load function documentation from index.php/rotate_vector_forward.tex.
- trans_rotUnable to load function documentation from index.php/trans_rot.tex.
- create_circ_csaThis function creates a cylindrical section array of circular transducers.
- create_circ_planar_arrayThis function creates a planar array of circular transducers.
- create_circ_ssaThis function creates a spherical section array of circular transducers.
- create_rect_csaThis function creates a cylindrical section array of rectangular transducers.
- create_rect_planar_arrayThis function creates a planar array of rectangular transducers.
- create_rect_ssaCreates a spherical section array of rectangular transducers.
- create_spherical_shell_planar_arrayCreates a planar array of spherical shell transducers.
- draw_arrayThis function creates a 3D representation of an arbitrary array of FOCUS transducers.
- draw_circThis is a helper function to draw the circular transducers, it is used by the draw_array function. Users are not expected to use this function.
- draw_rectThis is a helper function to draw the rectangular transducers, it is used by the draw_array function. Users are not expected to use this function.
- draw_sphericalshellThis is a helper function to draw a single spherical shell transducer, it is used by the draw_array function. Users are not expected to use this function.
- get_circThis function creates a circular transducer. It is intended to work with the create_circ_arrray functions, but it can be used independently.
- get_rectCreates a rectangular transducer. It is intended to work with the create_rect_array functions, but it can be used independently.
- get_spherical_shellThis function creates a spherical shell transducer. It is intended to be used independently.
- asa_callThis function will call the C++ binary ASA routine in the final version of the program, right now it calls the Matlab protected file that has the ASA functionality. This function does not have any error checking but will abort if an insufficient number of arguments is passed.
- asa_runIdentical to asa_call but with more error checking and some sanity checking to ensure a proper calculation will occur.
- farfield_cwCalculates the farfield pressure field generated by a transducer array.
- fftw_asaThis function is the C++ binary that implements the Angular Spectrum Approach. It should not be used in any scripts or used directly, as the interface can change. Use asa_call to ensure consistency. Documentation has been omitted. This is a mex function, if it doesn't run please e-mail focus@egr.msu.edu for help.
- fnm_callThis function is the gateway between the Matlab and C++ binary. It does minimal error checking to ensure enough arguments are being passed.
- fnm_cwThis function is the C++ binary that implements the FNM. It should not be used in any scripts or used directly, as the interface can change. Use fnm_call to ensure consistency. Documentation has been omitted. This is a mex function, if it doesn't run please e-mail focus@egr.msu.edu for help.
- fnm_cw_apodizedComputes the pressure from pistons or arrays under continuous wave excitation in homogeneous media.
- fnm_cw_singleComputes the pressure from pistons under continuous wave excitation in homogeneous media.
- fnm_runThis function is a guided function that does error checking and sanity checks on the input before feeding the information to the C++ binary to get the answer.
- fnm_transient
- fnm_transient_callCalculates the transient pressure field from an arbitrary transducer array using the Fast Nearfield Method.
- fnm_tsdCalculates the transient pressure field from an arbitrary transducer array using the Fast Nearfield Method.
- impulse_begin_and_end_timesFinds start and end times for impulse response calculations.
- impulse_responseCalculates the impulse response of a transducer array.
- rayleigh_cwCalculates pressure field generated by a transducer array in homogeneous media using the Rayleigh-Sommerfeld Integral.
- rayleigh_cw_apodizedCalculates pressure field generated by a transducer array in homogeneous media using the Rayleigh-Sommerfeld Integral.
- rayleigh_transientCalculates pressure field generated by a transducer array in homogeneous media using the Rayleigh-Sommerfeld Integral.
- set_center_coordinate_gridCreates a coordinate grid centered at the given point.
- set_coordinate_gridCreates a coordinate grid data structure used by FOCUS for various calculations.
- set_excitation_functionA function to create an excitation function suitable for use with fnm_transient_call and other transient based codes.
- set_time_samplesCreate a time sample struct for use with transient functions.
- find_phaseThis function finds a phase adjustment for each transducer such that the phase of all transducers at a given point is the same. This function will likely undergo some significant changes in the near future, but the overall form should remain the same.
- get_pressureThis function is to help people who are unfamiliar with Matlab matrix manipulation features to extract a pressure plane.
- make_tissuestructCreate a structure representing multiple layers of different tissues.
- set_parametersCreate a parameter struct for use with FNM functions.
- set_temporal_coordinate_gridCreates a coordinate grid for use with transient functions.
- find_multiple_focus_phasefind_multiple_focus_phase will produce an array of complex_weight shifts to focus an array defined by xdc at a the given points.
- find_single_focus_phasefind_single_focus_phase will produce an array of complex_weight shifts to focus an array defined by xdc at a given point (x,y,z).
- set_apodizationThis function is used to apodize transducer arrays by setting the complex weights of the individual transducers.
- set_digitized_time_delaysDetermine the time delays needed to focus a transducer array at the given point. Time delays are shifted to fit the temporal grid rather than being allowed to fall between temporal samples.
- set_time_delaysDetermine the time delays required to focus a transducer array at a given point. Time delays calculated with set_time_delays may fall between temporal samples. If this is unacceptable, use set_digitized_time_delays.
- pause2This is a call back function used by the C++ binary to force an update of the Matlab display buffer. It should not be changed or deleted under any circumstance. If this function is missing, the program WILL NOT WORK.
- rotate_vector_forwardInterprets Euler angles to rotate vectors.
- trans_rotThis is an internal function used by draw_array and its related functions. Users are not expected to use this function. It is designed to interpret Euler angles.
- pause2Unable to load function documentation from doc_gen.php/pause2.tex.
- rotate_vector_forwardUnable to load function documentation from doc_gen.php/rotate_vector_forward.tex.
- trans_rotUnable to load function documentation from doc_gen.php/trans_rot.tex.
- pause2Unable to load function documentation from index.php/pause2.tex.
- rotate_vector_forwardUnable to load function documentation from index.php/rotate_vector_forward.tex.
- trans_rotUnable to load function documentation from index.php/trans_rot.tex.
