get_rtm_method#

petpal.kinetic_modeling.fit_tac_with_rtms.get_rtm_method(method: str, bounds=False)#

Function for obtaining the appropriate reference tissue model.

This function accepts a string specifying a reference tissue model (RTM) analysis method. It returns a reference to the function that performs the selected analysis method.

  • If the method is ‘srtm’, ‘srtm2’, ‘frtm’, or ‘frtm2’, and bounds are provided, fitting

    functions with bounds are used.

  • If the method is ‘srtm’, ‘srtm2’, ‘frtm’, or ‘frtm2’, and bounds are not provided, fitting

    functions without bounds are used.

  • If the method is ‘mrtm-original’, ‘mrtm’ or ‘mrtm2’, related fitting methods are utilized.

Parameters:

  • method (str) – The name of the RTM. This should be one of the following strings: ‘srtm’, ‘srtm2’, ‘frtm’, ‘frtm2’, ‘mrtm-original’, ‘mrtm’ or ‘mrtm2’.

  • bounds – The bounds on parameters fit during RTM analysis. This value is only used to

  • None. (determine whether to return the method that uses bounds or the unbounded one. Default)

Returns:

function – A reference to the function that performs the corresponding graphical TAC analysis. The returned function will take arguments specific to the analysis method, such as input TAC values, tissue TAC values, TAC times in minutes, and threshold time in minutes.

Raises:

ValueError – If the method name is invalid and not one of ‘srtm’, ‘frtm’, ‘mrtm-original’, ‘mrtm’ or ‘mrtm2’.

See also

  • fit_srtm_to_tac_with_bounds()

  • fit_srtm_to_tac()

  • fit_frtm_to_tac_with_bounds()

  • fit_frtm_to_tac()

  • fit_srtm2_to_tac_with_bounds()

  • fit_srtm2_to_tac()

  • fit_frtm2_to_tac_with_bounds()

  • fit_frtm2_to_tac()

  • fit_mrtm_original_to_tac()

  • fit_mrtm_2003_to_tac()

  • fit_mrtm2_2003_to_tac()

On this page

This Page