ReciprocalLatticeVector
=======================

.. currentmodule:: diffsims.crystallography

.. autoclass:: ReciprocalLatticeVector

    
    
    .. rubric:: Attributes
    .. autosummary::
        :toctree:
        :template: custom-attribute-template.rst
        
        
        ReciprocalLatticeVector.allowed
        
        
        ReciprocalLatticeVector.azimuth
        
        
        ReciprocalLatticeVector.coordinate_format
        
        
        ReciprocalLatticeVector.coordinates
        
        
        ReciprocalLatticeVector.data
        
        
        ReciprocalLatticeVector.dim
        
        
        ReciprocalLatticeVector.dspacing
        
        
        ReciprocalLatticeVector.gspacing
        
        
        ReciprocalLatticeVector.h
        
        
        ReciprocalLatticeVector.has_hexagonal_lattice
        
        
        ReciprocalLatticeVector.hkil
        
        
        ReciprocalLatticeVector.hkl
        
        
        ReciprocalLatticeVector.i
        
        
        ReciprocalLatticeVector.k
        
        
        ReciprocalLatticeVector.l
        
        
        ReciprocalLatticeVector.multiplicity
        
        
        ReciprocalLatticeVector.ndim
        
        
        ReciprocalLatticeVector.norm
        
        
        ReciprocalLatticeVector.perpendicular
        
        
        ReciprocalLatticeVector.polar
        
        
        ReciprocalLatticeVector.radial
        
        
        ReciprocalLatticeVector.scattering_parameter
        
        
        ReciprocalLatticeVector.shape
        
        
        ReciprocalLatticeVector.size
        
        
        ReciprocalLatticeVector.structure_factor
        
        
        ReciprocalLatticeVector.theta
        
        
        ReciprocalLatticeVector.unit
        
        
        ReciprocalLatticeVector.x
        
        
        ReciprocalLatticeVector.xyz
        
        
        ReciprocalLatticeVector.y
        
        
        ReciprocalLatticeVector.z
        
    
    

    
    
    .. rubric:: Methods
    .. autosummary::
        :toctree:
        :template: custom-method-template.rst
        
        
        
        ReciprocalLatticeVector.angle_with
        
        
        ReciprocalLatticeVector.calculate_structure_factor
        
        
        ReciprocalLatticeVector.calculate_theta
        
        
        ReciprocalLatticeVector.cross
        
        
        ReciprocalLatticeVector.deepcopy
        
        
        ReciprocalLatticeVector.dot
        
        
        ReciprocalLatticeVector.dot_outer
        
        
        ReciprocalLatticeVector.draw_circle
        
        
        ReciprocalLatticeVector.empty
        
        
        ReciprocalLatticeVector.flatten
        
        
        ReciprocalLatticeVector.from_highest_hkl
        
        
        ReciprocalLatticeVector.from_miller
        
        
        ReciprocalLatticeVector.from_min_dspacing
        
        
        ReciprocalLatticeVector.from_path_ends
        
        
        ReciprocalLatticeVector.from_polar
        
        
        ReciprocalLatticeVector.get_circle
        
        
        ReciprocalLatticeVector.get_hkl_sets
        
        
        ReciprocalLatticeVector.get_nearest
        
        
        ReciprocalLatticeVector.get_random_sample
        
        
        ReciprocalLatticeVector.in_fundamental_sector
        
        
        ReciprocalLatticeVector.inverse_pole_density_function
        
        
        ReciprocalLatticeVector.mean
        
        
        ReciprocalLatticeVector.pole_density_function
        
        
        ReciprocalLatticeVector.print_table
        
        
        ReciprocalLatticeVector.random
        
        
        ReciprocalLatticeVector.reshape
        
        
        ReciprocalLatticeVector.rotate
        
        
        ReciprocalLatticeVector.sanitise_phase
        
        
        ReciprocalLatticeVector.scatter
        
        
        ReciprocalLatticeVector.squeeze
        
        
        ReciprocalLatticeVector.stack
        
        
        ReciprocalLatticeVector.symmetrise
        
        
        ReciprocalLatticeVector.to_miller
        
        
        ReciprocalLatticeVector.to_polar
        
        
        ReciprocalLatticeVector.transpose
        
        
        ReciprocalLatticeVector.unique
        
        
        ReciprocalLatticeVector.xvector
        
        
        ReciprocalLatticeVector.yvector
        
        
        ReciprocalLatticeVector.zero
        
        
        ReciprocalLatticeVector.zvector
        
    
    

.. minigallery:: diffsims.crystallography.ReciprocalLatticeVector
    :add-heading: Examples using ``ReciprocalLatticeVector``