Funciones integradas¶

Referencia completa de las clases y funciones disponibles en las macros de ReciPro.

Clase File¶

Función	Descripción
`File.GetDirectoryPath(filename)`	Mostrar el diálogo de selección de carpeta y devolver la ruta elegida; pasa `filename` para obtener en su lugar la carpeta que lo contiene
`File.GetFileName()`	Mostrar el diálogo de selección de archivo y devolver la ruta elegida
`File.GetFileNames()`	Mostrar el diálogo de selección de múltiples archivos y devolver la lista de rutas
`File.ReadCrystalList(filename)`	Cargar un archivo de lista de cristales (*.xml); omite `filename` para abrir un diálogo
`File.ReadCrystal(filename)`	Cargar un archivo de cristal CIF/AMC; omite `filename` para abrir un diálogo
`File.ExportAsCIF(filename)`	Exportar el cristal actual como CIF; omite `filename` para abrir un diálogo
`File.ReadText(filename)`	Leer un archivo de texto como UTF-8 y devolverlo como cadena; omite `filename` para abrir un diálogo. Se combina con `Crystal.LoadCifText()` / `SaveText()`
`File.SaveText(textData, filename)`	Guardar datos de texto en un archivo; escribe `textData` en UTF-8 y, si se omite `filename`, abre un diálogo de guardado

Clase Crystal¶

Lee el cristal seleccionado y, mediante un borrador pendiente, crea y edita cristales.

Lectura¶

Propiedad / Función	Descripción
`Crystal.Name`	Nombre del cristal
`Crystal.ChemicalFormula`	Fórmula química
`Crystal.Density`	Densidad (g/cm³)
`Crystal.GetCellInAng()`	Constantes de celda como `[a, b, c, alpha, beta, gamma]` (Å, grados)
`Crystal.SpaceGroupName`	Símbolo Hermann–Mauguin del grupo espacial, con el sufijo de configuración (`:2`, `:H`, …) cuando corresponde
`Crystal.SpaceGroupNumber`	Número del grupo espacial de las International Tables (1–230)
`Crystal.HasPending`	Si hay un borrador abierto

Creación y edición (borrador → Commit)¶

Un cristal se construye en un borrador pendiente: se inicia, se rellena con los setters y Commit() lo valida todo, construye el cristal y lo aplica como cristal actual en un solo paso (la GUI y todos los simuladores abiertos se actualizan, como al cargar un archivo CIF). Un Commit() fallido informa de todos los errores de validación juntos, no cambia nada y conserva el borrador, de modo que puede corregirse y volver a hacer Commit.

Función	Descripción
`Crystal.BeginCreate(name)`	Iniciar un borrador para un cristal nuevo
`Crystal.BeginEdit()`	Iniciar un borrador desde el cristal actual (se conservan celda, grupo espacial, átomos y orientación)
`Crystal.LoadCifText(cifText)`	Iniciar un borrador desde texto CIF (el contenido de un archivo .cif, no una ruta)
`Crystal.SetName(name)`	Renombrar el borrador
`Crystal.SetCellInAng(a, b, c, alpha, beta, gamma)`	Constantes de celda en Å y grados. Cada llamada reemplaza la celda completa; los argumentos omitidos se derivan de las restricciones del grupo espacial (para un cristal cúbico basta `a`), y los valores explícitos que las contradicen provocan un error
`Crystal.SetSpaceGroup(symbol)`	Grupo espacial por símbolo (HM corto/completo o Hall; espacios y `_` se ignoran). Añade la configuración (`'Fd-3m:2'`, `'R-3c:H'`, `'P21/c:b1'`) cuando el grupo tiene varias — los símbolos ambiguos provocan un error que lista los candidatos
`Crystal.SetSpaceGroupByNumber(itNumber, setting)`	Grupo espacial por número IT (1–230); `setting` (`'1'`, `'2'`, `'H'`, `'R'`, `'b1'`, …) elige entre varias configuraciones
`Crystal.AddAtom(label, element, x, y, z, occ, bIso)`	Añadir un átomo de la unidad asimétrica: símbolo del elemento, coordenadas fraccionarias, ocupación (0 < occ ≤ 1, por defecto 1) y B isotrópico en Å² (por defecto 0). Las posiciones equivalentes, letras de Wyckoff y multiplicidades se derivan automáticamente
`Crystal.ClearAtoms()`	Eliminar todos los átomos del borrador
`Crystal.Commit()`	Validar, construir y aplicar el borrador
`Crystal.Cancel()`	Descartar el borrador

ReciPro.Crystal.BeginCreate('NaCl')
ReciPro.Crystal.SetSpaceGroup('Fm-3m')
ReciPro.Crystal.SetCellInAng(5.6402)
ReciPro.Crystal.AddAtom('Na', 'Na', 0, 0, 0)
ReciPro.Crystal.AddAtom('Cl', 'Cl', 0.5, 0.5, 0.5)
ReciPro.Crystal.Commit()

base = ReciPro.Crystal.GetCellInAng()
for k in range(-2, 3):
    ReciPro.Crystal.BeginEdit()
    ReciPro.Crystal.SetCellInAng(base[0] * (1 + 0.01 * k))
    ReciPro.Crystal.Commit()

Tras un Commit() con éxito, el siguiente BeginEdit() parte del cristal actualizado, así que los cambios se acumulan — para barridos absolutos, lee los valores base antes del bucle, como arriba. Para registrar el cristal en la lista de cristales, llama a CrystalList.Add().

Clase CrystalList¶

Función / Propiedad	Descripción
`CrystalList.SelectedIndex`	Obtener/establecer el índice del cristal seleccionado
`CrystalList.Count`	Número de cristales que hay en la lista
`CrystalList.Add()`	Añadir el cristal actual a la lista
`CrystalList.Replace()`	Reemplazar el cristal seleccionado
`CrystalList.Delete()`	Eliminar el cristal seleccionado
`CrystalList.ClearAll()`	Vaciar todos los cristales
`CrystalList.MoveUp()`	Mover el cristal seleccionado hacia arriba
`CrystalList.MoveDown()`	Mover el cristal seleccionado hacia abajo

Clase Dir¶

Función	Descripción
`Dir.Euler(phi, theta, psi)`	Establecer la orientación mediante ángulos de Euler (radianes)
`Dir.EulerInDegree(phi, theta, psi)`	Establecer la orientación mediante ángulos de Euler (grados)
`Dir.EulerInDeg(phi, theta, psi)`	Alias de `EulerInDegree`
`Dir.Rotate(ax, ay, az, angle)`	Rotar alrededor de un eje arbitrario (radianes)
`Dir.RotateInDeg(ax, ay, az, angle)`	Rotar alrededor de un eje arbitrario (grados)
`Dir.RotateAroundAxis(u, v, w, angle)`	Rotar alrededor del eje de zona [uvw] (radianes)
`Dir.RotateAroundAxisInDeg(u, v, w, angle)`	Rotar alrededor del eje de zona [uvw] (grados)
`Dir.RotateAroundPlane(h, k, l, angle)`	Rotar alrededor de la normal del plano (hkl) (radianes)
`Dir.RotateAroundPlaneInDeg(h, k, l, angle)`	Rotar alrededor de la normal del plano (hkl) (grados)
`Dir.ProjectAlongPlane(h, k, l)`	Situar la normal del plano perpendicular a la pantalla
`Dir.ProjectAlongAxis(u, v, w)`	Situar el eje de zona perpendicular a la pantalla
`Dir.GetEuler()`	Obtener la orientación actual como ángulos de Euler Z-X-Z `[phi, theta, psi]` (radianes)
`Dir.GetEulerInDeg()`	Obtener la orientación actual como ángulos de Euler Z-X-Z `[phi, theta, psi]` (grados)
`Dir.GetRotationMatrix()`	Obtener la matriz de rotación actual como un array de nueve elementos `[R11, R12, R13, R21, R22, R23, R31, R32, R33]`, la misma convención que `SpotID.CandidateList()`
`Dir.SetRotationMatrix(r11, r12, r13, r21, r22, r23, r31, r32, r33)`	Establecer la orientación a partir de nueve elementos de la matriz de rotación (validados y reortonormalizados antes de aplicarse)

Los ángulos de Euler no son únicos en las posiciones de bloqueo de cardán (θ = 0 o 180°): GetEuler() tras Euler() reproduce la misma actitud, pero no necesariamente los mismos números. Para guardar y restaurar la orientación con exactitud, usa Dir.GetRotationMatrix() / Dir.SetRotationMatrix(). La convención completa se describe en Geometría de rotación.

Clase DifSim¶

Control de ventana¶

DifSim.Open() / DifSim.Close()

Fuente de ondas¶

DifSim.Source_Xray() / DifSim.Source_Electron() / DifSim.Source_Neutron()

Propiedades¶

Propiedad	Tipo	Descripción
`Energy`	double	Energía (keV)
`Wavelength`	double	Longitud de onda (Å)
`Thickness`	double	Espesor de la muestra (nm)
`NumberOfDiffractedWaves`	int	Número de ondas de Bloch
`CameraLength2`	double	Longitud de cámara (mm)
`SkipRendering`	bool	Omitir el renderizado para el procesamiento por lotes

Modo de haz¶

Beam_Parallel() / Beam_PrecessionXray() / Beam_PrecessionElectron() / Beam_Convergence()

Modo de cálculo¶

Calc_Excitation() / Calc_Kinematical() / Calc_Dynamical()

Ajustes de imagen¶

Propiedad / Función	Descripción
`ImageResolutionInMM`	Resolución (mm/píxel)
`ImageResolutionInNMinv`	Resolución (nm⁻¹/píxel)
`ImageWidth` / `ImageHeight`	Tamaño de imagen (píxeles)
`ImageSize(w, h)`	Establecer el tamaño de imagen

Detector¶

Propiedad	Descripción
`Tau` / `TauInDeg`	Ángulo de inclinación del detector τ (rad / grados)
`Phi` / `PhiInDeg`	Eje de rotación del detector φ (rad / grados)
`Foot(x, y)`	Posición de foot en píxeles

Salida¶

Función	Descripción
`SaveAsPng(filename)`	Guardar el patrón actual como PNG; omite `filename` para abrir un diálogo
`SpotInfo()`	Obtener los datos de reflexiones como cadena CSV

Clase SpotID¶

Controla Spot ID v2 desde una macro: cargar una imagen o una lista de puntos, detectar los puntos, buscar orientaciones y recuperar los candidatos, sin tocar la ventana. FindSpots() e Identify() solo regresan cuando el trabajo ha terminado, así que pueden encadenarse directamente.

Control de la ventana¶

SpotID.Open() / SpotID.Close()

Fuente de onda¶

SpotID.Source_Xray() / SpotID.Source_Electron() / SpotID.Source_Neutron()

Flujo de trabajo¶

Función	Descripción
`SpotID.LoadFile(filename)`	Cargar un archivo igual que File > Load: `.csv` se lee como lista de puntos (antes debe haberse cargado una imagen) y cualquier otra extensión como imagen de patrón de difracción (dm3, dm4, mrc, ipa, tif y otros formatos admitidos). Omite `filename` para abrir un diálogo de archivo
`SpotID.FindSpots()`	Detectar los puntos de la imagen cargada y ajustarlos, como hace el botón Find spots
`SpotID.Identify()`	Buscar orientaciones que expliquen los puntos detectados, como hace el botón Identify spots, y devolver el número de candidatos. Se prueban los cristales seleccionados en la lista de cristales de la ventana principal
`SpotID.CandidateList()`	Devolver la lista de orientaciones candidatas como texto CSV
`SpotID.SpotList()`	Devolver los puntos observados como texto CSV, con las mismas columnas que File > Save. Combínalo con `File.SaveText()` para escribir un archivo que `LoadFile()` pueda volver a leer

CandidateList() da, por cada candidato: nombre del cristal, los ángulos de Euler Z-X-Z (grados), los nueve elementos R11–R33 de la matriz de rotación (del sistema del cristal al del laboratorio, aplicada a vectores columna), el residuo cuadrático medio (nm⁻²) y la asignación de los puntos observados a índices hkl. Los candidatos vienen ordenados por número de puntos asignados (descendente) y luego por el residuo (ascendente). Los números se escriben en la cultura invariante, así que el separador decimal es siempre un punto.

Propiedades¶

Propiedad	Tipo	Descripción
`Energy`	double	Energía del haz (keV para rayos X y electrones, meV para neutrones)
`CameraLength`	double	Longitud de cámara (mm)
`PixelSizeInMM`	double	Tamaño de píxel (mm); leerlo o escribirlo cambia también la unidad del tamaño de píxel a mm
`PixelSizeInNMinv`	double	Tamaño de píxel (nm⁻¹); leerlo o escribirlo cambia también la unidad a nm⁻¹
`MaxNumberOfSpots`	int	Número máximo de puntos que `FindSpots()` puede detectar
`NearestNeighbor`	int	Separación mínima permitida entre puntos detectados (píxeles)
`FittingRange`	double	Radio de la región alrededor de cada punto empleada en el ajuste del pico (píxeles)
`AcceptableError`	double	Tolerancia de la diferencia relativa de espaciado d al emparejar puntos con reflexiones (%)
`IgnoreProhibitedReflections`	bool	Ignorar las reflexiones prohibidas cinemáticamente, que aun así pueden aparecer por difracción múltiple
`MultiGrain`	bool	Buscar varios granos; `False` significa un solo grano
`MaxNumberOfGrains`	int	Número máximo de orientaciones de grano buscadas cuando `MultiGrain` es `True`
`NumberOfDetectedSpots`	int	Número de puntos detectados (solo lectura)
`NumberOfCandidates`	int	Número de candidatos hallados por el último `Identify()` (solo lectura)

Clase StructureViewer¶

Controla el visor de estructura desde una macro. SaveImage() y Export3DModel() abren antes la ventana si es necesario, porque el modelo 3D se construye al mostrarla.

Función	Descripción
`StructureViewer.Open()`	Abrir la ventana del visor de estructura
`StructureViewer.Close()`	Cerrar la ventana del visor de estructura
`StructureViewer.SaveImage(filename)`	Guardar la vista principal renderizada como PNG, con el tamaño en píxeles del cuadro Size (W×H); omite `filename` para abrir un diálogo
`StructureViewer.Export3DModel(filename, maxSizeInMM, fixedScaleInMMperNm, includeAtoms, includeBonds, includePolyhedra, polyhedraAsEdges, polyEdgeDiaInMM, includeCellEdges, cellEdgeDiaInMM, thickenBondsToMM)`	Exportar la estructura mostrada para impresión 3D, como Export 3D Model (3MF/STL) del menú File. La extensión decide el formato (`.stl` monocolor / `.3mf` coloreado por elemento); solo `filename` es obligatorio — los demás valores por defecto son los del diálogo (dimensión mayor 80 mm, aristas de la celda ⌀2,4 mm, enlaces engrosados a ⌀1,2 mm). Con `fixedScaleInMMperNm` > 0 se construyen varios modelos a la misma escala

ReciPro.StructureViewer.Export3DModel('D:/print/NaCl_60mm.stl', maxSizeInMM=60)
ReciPro.StructureViewer.Export3DModel('D:/print/NaCl_edges.stl', maxSizeInMM=60, polyhedraAsEdges=True)

Clases HRTEM / STEM / Potential¶

Estas tres clases de simulación de imágenes comparten muchos miembros. Para evitar repeticiones, las tablas siguientes utilizan marcadores de posición:

# : común a HRTEM, STEM y Potential. Reemplace # por HRTEM, STEM o Potential (p. ej. STEM.Simulate(), Potential.AccVol).
$ : común únicamente a HRTEM y STEM. Reemplace $ por HRTEM o STEM.
Los miembros escritos con un nombre de clase explícito (STEM.… / HRTEM.…) pertenecen solo a esa clase. La clase Potential no añade miembros propios; utiliza únicamente los miembros #.

Control de ventana¶

Función	Descripción
`#.Open()`	Abrir la ventana del Simulador de imágenes
`#.Close()`	Cerrar la ventana del Simulador de imágenes
`#.Simulate()`	Ejecutar la simulación con los ajustes actuales

Microscopio / óptica¶

Propiedad / Función	Descripción
`#.AccVol`	Voltaje de aceleración (kV)
`$.Thickness`	Espesor de la muestra (nm)
`$.Defocus`	Desenfoque (nm)
`$.Cs`	Aberración esférica Cs (mm)
`$.Cc`	Aberración cromática Cc (mm)
`$.DeltaV`	Dispersión de energía ΔV, FWHM (eV)
`$.Scherzer`	Desenfoque de Scherzer (nm, solo lectura)
`STEM.ConvergenceAngle`	Semiángulo de convergencia (mrad)
`STEM.DetectorInnerAngle` / `STEM.DetectorOuterAngle`	Semiángulo interior/exterior del detector anular (mrad)
`STEM.EffectiveSourceSize`	Tamaño efectivo de la fuente, FWHM (pm)
`HRTEM.Beta`	Semiángulo de iluminación β (radianes)
`HRTEM.ApertureSemiangle`	Semiángulo del diafragma objetivo (radianes)
`HRTEM.ApertureShiftX` / `HRTEM.ApertureShiftY`	Desplazamiento del diafragma objetivo (radianes)
`HRTEM.OpenAperture`	Diafragma objetivo abierto (true/false)

Propiedades de simulación¶

Propiedad / Función	Descripción
`#.NumberOfDiffractedWaves`	Número máximo de ondas difractadas (de Bloch)
`#.ImageWidth` / `#.ImageHeight`	Tamaño de imagen (píxeles)
`#.ImageSize(width, height)`	Establecer el tamaño de imagen (píxeles)
`#.ImageResolution`	Resolución de imagen (nm/píxel)
`STEM.AngularResolution`	Resolución angular del haz convergente (mrad)
`STEM.SliceThickness`	Espesor de capa para el cálculo de TDS (nm)
`HRTEM.Mode_LinearImage()`	Usar el modelo de imagen lineal (cuasi-coherente)
`HRTEM.Mode_TCC()`	Usar el modelo TCC (coeficiente cruzado de transmisión)

Modo de imagen única / en serie¶

Propiedad / Función	Descripción
`$.SingleImageMode()`	Cambiar al modo de imagen única
`$.SerialImageMode(withThickness, withDefocus)`	Cambiar al modo de imagen en serie
`$.SerialImageThicknessStart` / `Step` / `Num`	Espesor en serie: inicio (nm) / paso (nm) / cantidad
`$.SerialImageDefocusStart` / `Step` / `Num`	Desenfoque en serie: inicio (nm) / paso (nm) / cantidad

Propiedades de imagen¶

Propiedad / Función	Descripción
`#.UnitCellVisible`	Mostrar la celda elemental (true/false)
`#.LabelVisible`	Mostrar la etiqueta de la imagen (true/false)
`#.LabelSize`	Tamaño de fuente de la etiqueta
`#.ScaleBarVisible`	Mostrar la barra de escala (true/false)
`#.ScaleBarLength`	Longitud de la barra de escala (nm)
`#.GaussianBlurEnabled`	Aplicar desenfoque gaussiano (true/false)
`#.GaussianBlurFWHM`	FWHM del desenfoque gaussiano (pm)
`STEM.DisplayBoth()`	Mostrar las componentes elástica y de TDS
`STEM.DisplayElastic()`	Mostrar solo la componente elástica
`STEM.DisplayTDS()`	Mostrar solo la componente de TDS (inelástica)

Guardar imagen¶

Propiedad / Función	Descripción
`#.SaveImageAsPng(filename)`	Guardar como PNG (diálogo si se omite filename)
`#.SaveImageAsTif(filename)`	Guardar como TIFF (diálogo si se omite filename)
`#.SaveImageAsEmf(filename)`	Guardar como metarchivo EMF (diálogo si se omite filename)
`#.SaveIndividually`	En modo serie, guardar cada imagen por separado (true/false)
`#.OverprintSymbols`	Sobreimprimir celda elemental / etiquetas / barra de escala en las imágenes guardadas (true/false)

Funciones globales¶

Función	Descripción
`Sleep(ms)`	Esperar el número de milisegundos especificado

Funciones integradas¶

Clase File¶

Clase Crystal¶

Lectura¶

Creación y edición (borrador → Commit)¶

Clase CrystalList¶

Clase Dir¶

Clase DifSim¶

Control de ventana¶

Fuente de ondas¶

Propiedades¶

Modo de haz¶

Modo de cálculo¶

Ajustes de imagen¶

Detector¶

Salida¶

Clase SpotID¶

Control de la ventana¶

Fuente de onda¶

Flujo de trabajo¶

Propiedades¶

Clase StructureViewer¶

Clases HRTEM / STEM / Potential¶

Control de ventana¶

Microscopio / óptica¶

Propiedades de simulación¶

Modo de imagen única / en serie¶

Propiedades de imagen¶

Guardar imagen¶

Funciones globales¶

Véase también¶