.. _api_lattice:

*******
Lattice
*******

.. currentmodule:: radtools

Class
=====

.. autosummary::
    :toctree: generated/

    Lattice

Lattice parameters
==================

Real space
----------

.. autosummary::

    Lattice.a1
    Lattice.a2
    Lattice.a3
    Lattice.cell
    Lattice.unit_cell_volume
    Lattice.a
    Lattice.b
    Lattice.c
    Lattice.alpha
    Lattice.beta
    Lattice.gamma
    Lattice.parameters

Reciprocal space
----------------

.. autosummary::

    Lattice.b1
    Lattice.b2
    Lattice.b3
    Lattice.reciprocal_cell
    Lattice.reciprocal_cell_volume
    Lattice.k_a
    Lattice.k_b
    Lattice.k_c
    Lattice.k_alpha
    Lattice.k_beta
    Lattice.k_gamma
    Lattice.parameters
    Lattice.path

Information properties
======================

.. autosummary::

    Lattice.variation
    Lattice.pearson_symbol
    Lattice.centring_type
    Lattice.crystal_family


Plotting
========

.. autosummary::

    Lattice.plot
    Lattice.legend
    Lattice.remove
    Lattice.savefig
    Lattice.show
    Lattice.clear