Cette page a été traduite par traduction automatique. Cliquez ici pour voir la dernière version en anglais.

report

Créer un rapport de référence

Depuis R2022b

réduire tous les éléments de la page

    Syntaxe

    report(plannerBM)
    report(plannerBM,filename)
    report(plannerBM,filename,Name=Value)

    Description

    report(plannerBM) crée et ouvre un rapport de référence en tant que live script (.mlx) dans l'éditeur MATLAB® . La fonction enregistre le rapport dans le répertoire de travail actuel avec le nom de fichier par défaut.

    Remarque

    La fonction report exporte également l'objet d'entrée plannerBenchmark vers un fichier MAT et place le fichier dans un dossier appelé plannerBenchmark, situé dans le même répertoire que le rapport enregistré.

    report(plannerBM,filename) spécifie le nom et l'emplacement filename du rapport enregistré.

    report(plannerBM,filename,Name=Value) spécifie les options en utilisant un ou plusieurs arguments nom-valeur. Par exemple, report(plannerBM,"reportFile",Open=false) crée un fichier de rapport de référence nommé reportFile.mlx et l'enregistre dans le répertoire de travail actuel, mais n'ouvre pas le rapport dans le MATLAB éditeur.

    exemple

    Exemples

    réduire tout

    Ouvrir le live script

    Créez une carte d'occupation à partir d'un exemple de carte.

    load("exampleMaps.mat","simpleMap");
map = occupancyMap(simpleMap);

    Créez un validateur d'état dans l'espace d'état SE(2) à l'aide de la carte.

    sv = validatorOccupancyMap(stateSpaceSE2,Map=map);

    Spécifiez les états de départ et d’objectif.

    start = [5 8 pi/2];
goal = [7 18 pi/2];

    Créez un objet plannerBenchmark .

    pbo = plannerBenchmark(sv,start,goal);

    Définissez les handles de fonction pour les fonctions d'initialisation des planificateurs.

    plannerHAFcn = @(sv)plannerHybridAStar(sv);
plannerRRTSFcn = @(sv)plannerRRTStar(sv.StateSpace,sv);

    Définissez le descripteur de fonction pour la fonction de plan, qui est partagé par les deux planificateurs.

    plnFcn = @(initOut,s,g)plan(initOut,s,g);

    Ajoutez les planificateurs de chemin pour l'analyse comparative à l'objet plannerBenchmark .

    addPlanner(pbo,plnFcn,plannerHAFcn);
addPlanner(pbo,plnFcn,plannerRRTSFcn,PlannerName="ppRRTStar");

    Configurez le générateur de nombres aléatoires pour garantir un résultat reproductible.

    rng("default")

    Exécutez les planificateurs de chemin cinq fois chacun pour collecter des métriques.

    runCount = 5;
runPlanner(pbo,runCount)
    Initializing plannerHAFcn_plnFcn ...
Done.
Planning a path from the start pose (5 8 1.5708) to the goal pose (7 18 1.5708) using plannerHAFcn_plnFcn.
Executing run 1.
Executing run 2.
Executing run 3.
Executing run 4.
Executing run 5.
Initializing ppRRTStar ...
Done.
Planning a path from the start pose (5 8 1.5708) to the goal pose (7 18 1.5708) using ppRRTStar.
Executing run 1.
Executing run 2.
Executing run 3.
Executing run 4.
Executing run 5.

    Générez un fichier de rapport de référence nommé reportFile.mlx qui contient les mesures de dégagement et de fluidité. La fonction ouvre le rapport dans l'éditeur MATLAB .

    report(pbo,"reportFile",Metric=["clearance","smoothness"])

    Exécutez le reportFile.mlx pour visualiser les résultats de référence des planificateurs de chemin 2D spécifiés pour chaque métrique spécifiée.

    Arguments d'entrée

    réduire tout

    Benchmark du planificateur de chemin, spécifié comme objet plannerBenchmark .

    Nom du fichier de rapport, spécifié sous forme de chaîne scalaire ou de vecteur de caractères. Le nom du fichier peut inclure un chemin absolu, un chemin relatif ou aucun chemin. La spécification de l’extension .mlx est facultative.

    Exemple : "reportFile"

    Exemple : "reportFile.mlx"

    Exemple : "mydir/reportFile"

    Exemple : "mydir/reportFile.mlx"

    Exemple : "C:/mydir/reportFile"

    Exemple : "C:/mydir/reportFile.mlx"

    Types de données : char | string

    Arguments nom-valeur

    réduire tout

    Spécifiez des paires d'arguments facultatives sous la forme Name1=Value1,...,NameN=ValueN, où Name est le nom de l'argument et Value est la valeur correspondante. Les arguments nom-valeur doivent apparaître après les autres arguments, mais l'ordre des paires n'a pas d'importance.

    Exemple : report(plannerBM,"reportFile",Open=false) crée un fichier de rapport de référence nommé reportFile.mlx dans le répertoire courant, mais n'ouvre pas le rapport dans l'éditeur MATLAB .

    Métriques à inclure dans le rapport, spécifiées sous forme de chaîne scalaire, de vecteur de caractères, de tableau de chaînes ou de cell array de vecteurs de caractères de métriques prises en charge. Les métriques prises en charge sont :

    • "clearance"

    • "executionTime"

    • "initializationTime"

    • "isPathValid"

    • "pathLength"

    • "smoothness"

    Exemple : Metric="clearance"

    Exemple : Metric='clearance'

    Exemple : Metric=["clearance","executionTime"]

    Exemple : Metric={'clearance','executionTime'}

    Types de données : char | string | cell

    Sections de contenu à exclure du rapport, spécifiées sous forme de chaîne scalaire, de vecteur de caractères, de tableau de chaînes ou de cell array de vecteurs de caractères de contenus d'exclusion pris en charge. Les contenus d'exclusion pris en charge sont :

    • "PathVisualization"

    • "DetailedTable"

    La spécification de "PathVisualization" exclut la section Visualize Path on Map du rapport. La spécification de "DetailedTable" exclut les tableaux de métriques contenant les résultats des métriques pour les planificateurs des exécutions de planification individuelles.

    Exemple : Exclude="PathVisualization"

    Exemple : Exclude='PathVisualization'

    Exemple : Exclude=["PathVisualization","DetailedTable"]

    Exemple : Exclude={'PathVisualization','DetailedTable'}

    Types de données : char | string | cell

    Le rapport s'ouvre dans l'éditeur, spécifié comme un 1 (true) ou 0 (false). Lorsque vous spécifiez cet argument comme true, la fonction ouvre le rapport dans l'éditeur MATLAB . Dans le cas contraire, il n'ouvre pas l'état sous l'éditeur.

    Exemple : Open=false

    Types de données : logical

    Historique des versions

    Introduit dans R2022b

    Voir aussi

    Objets

    Fonctions