Esta página se ha traducido mediante traducción automática. Haga clic aquí para ver la última versión en inglés.

report

Crear informe de referencia

Desde R2022b

contraer todo en la página

    Sintaxis

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

    Descripción

    report(plannerBM) crea y abre un informe de referencia como un script en vivo (.mlx) en el editor MATLAB®. La función guarda el informe en el directorio de trabajo actual con el nombre de archivo predeterminado.

    Nota

    La función report también exporta el objeto de entrada plannerBenchmark a un archivo MAT y coloca el archivo en una carpeta llamada plannerBenchmark, ubicada en el mismo directorio que el informe guardado.

    report(plannerBM,filename) especifica el nombre y la ubicación filename del informe guardado.

    report(plannerBM,filename,Name=Value) especifica opciones utilizando uno o más argumentos de nombre-valor. Por ejemplo, report(plannerBM,"reportFile",Open=false) crea un archivo de informe de referencia llamado reportFile.mlx y lo guarda en el directorio de trabajo actual, pero no abre el informe en el editor MATLAB.

    ejemplo

    Ejemplos

    contraer todo

    Abrir script en vivo

    Cree un mapa de ocupación a partir de un mapa de ejemplo.

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

    Cree un validador de estado en el espacio de estado SE(2) usando el mapa.

    sv = validatorOccupancyMap(stateSpaceSE2,Map=map);

    Especifique los estados de inicio y objetivo.

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

    Cree un objeto plannerBenchmark.

    pbo = plannerBenchmark(sv,start,goal);

    Defina los identificadores de funciones para las funciones de inicialización de los planificadores.

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

    Defina el identificador de función para la función del plan, que comparten ambos planificadores.

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

    Agregue los planificadores de rutas para la evaluación comparativa al objeto plannerBenchmark.

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

    Configure el generador de números aleatorios para garantizar un resultado repetible.

    rng("default")

    Ejecute los planificadores de ruta cinco veces cada uno para recopilar métricas.

    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.

    Genere un archivo de informe de referencia llamado reportFile.mlx que contenga las métricas de espacio libre y suavidad. La función abre el informe en el editor MATLAB .

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

    Ejecute reportFile.mlx para visualizar los resultados de referencia de los planificadores de rutas 2-D especificados para cada métrica especificada.

    Argumentos de entrada

    contraer todo

    Punto de referencia del planificador de rutas, especificado como un objeto plannerBenchmark.

    Nombre del archivo de informe, especificado como escalar de cadena o vector de caracteres. El nombre del archivo puede incluir una ruta absoluta, una ruta relativa o ninguna ruta. Especificar la extensión .mlx es opcional.

    Ejemplo: "reportFile"

    Ejemplo: "reportFile.mlx"

    Ejemplo: "mydir/reportFile"

    Ejemplo: "mydir/reportFile.mlx"

    Ejemplo: "C:/mydir/reportFile"

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

    Tipos de datos: char | string

    Argumentos de par nombre-valor

    contraer todo

    Especifique pares de argumentos opcionales como Name1=Value1,...,NameN=ValueN, donde Name es el nombre del argumento y Value es el valor correspondiente. Los argumentos nombre-valor deben aparecer después de los otros argumentos, pero el orden de los pares no importa.

    Ejemplo: report(plannerBM,"reportFile",Open=false) crea un archivo de informe de referencia llamado reportFile.mlx en el directorio actual, pero no abre el informe en el editor MATLAB.

    Métricas que se incluirán en el informe, especificadas como un escalar de cadena, un vector de caracteres, un arreglo de cadenas o un arreglo de celdas de vectores de caracteres de métricas admitidas. Las métricas admitidas son:

    • "clearance"

    • "executionTime"

    • "initializationTime"

    • "isPathValid"

    • "pathLength"

    • "smoothness"

    Ejemplo: Metric="clearance"

    Ejemplo: Metric='clearance'

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

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

    Tipos de datos: char | string | cell

    Secciones de contenido que se excluirán del informe, especificadas como un escalar de cadena, un vector de caracteres, un arreglo de cadenas o un arreglo de celdas de vectores de caracteres de contenidos de exclusión admitidos. Los contenidos de exclusión admitidos son:

    • "PathVisualization"

    • "DetailedTable"

    Al especificar "PathVisualization" se excluye la sección Visualize Path on Map del informe. Al especificar "DetailedTable" se excluyen las tablas de métricas que contienen los resultados de métricas para los planificadores de las ejecuciones de planificación individuales.

    Ejemplo: Exclude="PathVisualization"

    Ejemplo: Exclude='PathVisualization'

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

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

    Tipos de datos: char | string | cell

    El informe se abre en el editor, especificado como 1 (true) o 0 (false) lógico. Cuando se especifica este argumento como true, la función abre el informe en el editor MATLAB. De lo contrario, no abre el informe en el editor.

    Ejemplo: Open=false

    Tipos de datos: logical

    Historial de versiones

    Introducido en R2022b

    Consulte también

    Objetos

    Funciones