Creates a pole-zero scatter plot. If parameter stepping of the instruction is enabled, a root locus is drawn with the parameter as root locus variable. In such cases special begin end endpoint markers are used: - poles begin of root locus: 'x' - poles end of root locus: '
(fileName, title, results, xmin = None, xmax = None,
ymin = None, ymax = None, xscale = '', yscale = '', show = False, save = True)
| 916 | return fig |
| 917 | |
| 918 | def plotPZ(fileName, title, results, xmin = None, xmax = None, |
| 919 | ymin = None, ymax = None, xscale = '', yscale = '', show = False, save = True): |
| 920 | """ |
| 921 | Creates a pole-zero scatter plot. |
| 922 | |
| 923 | If parameter stepping of the instruction is enabled, a root locus is drawn |
| 924 | with the parameter as root locus variable. |
| 925 | |
| 926 | In such cases special begin end endpoint markers are used: |
| 927 | |
| 928 | - poles begin of root locus: 'x' |
| 929 | - poles end of root locus: '+' |
| 930 | - zeros begin of root locus: 'o' |
| 931 | - zeros end of root locus: 'square' |
| 932 | |
| 933 | The root locus itself is drawn with dots for each position of a pole or zero. |
| 934 | |
| 935 | Results of multiple analysis can be combined in one plot by putting them in |
| 936 | a list. |
| 937 | |
| 938 | The type of the axis is 'lin'. |
| 939 | |
| 940 | :param fileName: Name of the file for saving it to disk. |
| 941 | :type fileName: str |
| 942 | |
| 943 | :param title: Title of the figure. |
| 944 | :type title: str |
| 945 | |
| 946 | :param results: Results of the execution of an instruction, or a list with |
| 947 | SLiCAPinstruction.instruction objects. The data type of these |
| 948 | instructions should be 'poles', 'zeros' or 'pz'. |
| 949 | :type results: list, SLiCAPinstruction.instruction |
| 950 | |
| 951 | :param xmin: Minimum value of the x axis; defaults to None. |
| 952 | :type xmin: int, float, str |
| 953 | |
| 954 | :param xmax: Maximum value of the x axis; defaults to None. |
| 955 | :type xmax: int, float, str |
| 956 | |
| 957 | :param ymin: Minimum value of the y axis; defaults to None. |
| 958 | :type ymin: int, float, str |
| 959 | |
| 960 | :param ymax: Maximum value of the y axis; defaults to None. |
| 961 | :type ymax: int, float, str |
| 962 | |
| 963 | :param xscale: x axis scale factor; defaults to ''. |
| 964 | :type xscale: str |
| 965 | |
| 966 | :param yscale: y axis scale factor; defaults to ''. |
| 967 | :type yscale: str |
| 968 | |
| 969 | :param show: If 'True' the plot will be shown in the workspace. Defaults to False. |
| 970 | :type show: bool |
| 971 | |
| 972 | :param save: If 'True' the plot will be saved to the img folder in both pdf and svg format. Defaults to True. |
| 973 | :type show: bool |
| 974 | |
| 975 | :return: fig |
nothing calls this directly
no test coverage detected